Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-updateSystemLevelEndpointTag","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointtagid","in":"path","description":"The ENDPOINTTAGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tag_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["API"],"summary":"Delete System Level Endpoint Tag","description":"Delete System Level Endpoint Tag.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteSystemLevelEndpointTag","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointtagid","in":"path","description":"The ENDPOINTTAGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/consumers/{consumerid}/consumer/rate-limits/{ratelimitingid}":{"put":{"tags":["Consumer","Rate-Limits"],"summary":"Set Rate Limits / Call Limits per Consumer","description":"Set the API rate limits / call limits for a Consumer:
\nRate limiting can be set:
\nPer Second
\nPer Minute
\nPer Hour
\nPer Week
\nPer Month
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nRATE_LIMITING_ID: RATE_LIMITING_ID
\nJSON response body fields:
\nfrom_date: 1100-01-01T01:01:01.000Z
\n\n\n\n\n\n\nto_date: 1100-01-01T01:01:01.000Z
\napi_name: api_name
\n\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-updateRateLimits","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}},{"name":"ratelimitingid","in":"path","description":"The RATELIMITINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","per_week_call_limit","per_day_call_limit","per_second_call_limit","per_month_call_limit","per_hour_call_limit","per_minute_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","per_week_call_limit","per_day_call_limit","per_second_call_limit","per_month_call_limit","per_hour_call_limit","per_minute_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Consumer"],"summary":"Delete Rate Limit by Rate Limiting ID","description":"Delete a specific Rate Limit by Rate Limiting ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nRATE_LIMITING_ID: RATE_LIMITING_ID
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteCallLimits","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}},{"name":"ratelimitingid","in":"path","description":"The RATELIMITINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/{userid}/api-collections":{"get":{"tags":["Api-Collection"],"summary":"Get Api Collections for User","description":"Get Api Collections for User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getApiCollectionsForUser","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collections"],"properties":{"api_collections":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/my/customers":{"get":{"tags":["Customer"],"summary":"Get My Customers at Bank","description":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv5.0.0-getMyCustomersAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","customer_id","relationship_status","last_ok_date","bank_id","highest_education_attained","customer_number","credit_rating","legal_name","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/tags":{"get":{"tags":["API"],"summary":"Get API Tags","description":"Get API TagsGet API Tags
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","operationId":"OBPv5.1.0-getApiTags","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/management/consumers/{consumerid}/active-rate-limits/{datewithhour}":{"get":{"tags":["Consumer"],"summary":"Get Active Rate Limits for Hour","description":"Get the active rate limits for a consumer for a specific hour. Returns the aggregated rate limits from all active records during that hour.
\nRate limits are cached and queried at hour-level granularity.
\nSee [here](/glossary#Rate Limiting) for more details on how rate limiting works.
\nDate format: YYYY-MM-DD-HH in UTC timezone (e.g. 2025-12-31-13 for hour 13:00-13:59 UTC on Dec 31, 2025)
\nNote: The hour is always interpreted in UTC for consistency across all servers.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nDATE_WITH_HOUR: DATE_WITH_HOUR
\nJSON response body fields:
\nactive_at_date: active_at_date
\nactive_per_day_rate_limit: active_per_day_rate_limit
\nactive_per_hour_rate_limit: active_per_hour_rate_limit
\nactive_per_minute_rate_limit: active_per_minute_rate_limit
\nactive_per_month_rate_limit: active_per_month_rate_limit
\nactive_per_second_rate_limit: active_per_second_rate_limit
\nactive_per_week_rate_limit: active_per_week_rate_limit
\nconsidered_rate_limit_ids: considered_rate_limit_ids
\n","operationId":"OBPv6.0.0-getActiveRateLimitsAtDate","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}},{"name":"datewithhour","in":"path","description":"The DATEWITHHOUR identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["active_per_minute_rate_limit","active_per_hour_rate_limit","active_per_day_rate_limit","active_per_second_rate_limit","considered_rate_limit_ids","active_at_date","active_per_week_rate_limit","active_per_month_rate_limit"],"properties":{"active_at_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"active_per_second_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_day_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_week_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"considered_rate_limit_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"active_per_minute_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_month_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_hour_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"active_per_minute_rate_limit":{"type":"integer"},"active_per_hour_rate_limit":{"type":"integer"},"active_per_day_rate_limit":{"type":"integer"},"active_per_second_rate_limit":{"type":"integer"},"considered_rate_limit_ids":{"type":"array","items":{"type":"string"}},"active_at_date":{"type":"string","format":"date-time"},"active_per_week_rate_limit":{"type":"integer"},"active_per_month_rate_limit":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{counterparty}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (COUNTERPARTY)","description":"For an introduction to Transaction Requests, see: here
\nWhen using a COUNTERPARTY to create a Transaction Request, specify the counterparty_id in the body of the request.
\nThe routing details of the counterparty will be forwarded to the Core Banking System (CBS) for the transfer.
COUNTERPARTY Transaction Requests are used for Variable Recurring Payments (VRP). Use the following endpoint to create a consent for VRPs.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\nattribute_type: STRING
\ncharge_policy: SHARED
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nto:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestCounterparty","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterparty","in":"path","description":"The COUNTERPARTY identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","future_date","value","charge_policy","attributes","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attribute_type","name","value"],"properties":{"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID":{"get":{"tags":["Dynamic-Resource-Doc"],"summary":"Get Bank Level Dynamic Resource Doc by Id","description":"Get a Bank Level Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-getBankLevelDynamicResourceDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Dynamic-Resource-Doc"],"summary":"Update Bank Level Dynamic Resource Doc","description":"Update a Bank Level Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-updateBankLevelDynamicResourceDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Resource-Doc"],"summary":"Delete Bank Level Dynamic Resource Doc","description":"Delete a Bank Level Dynamic Resource Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankLevelDynamicResourceDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/branch":{"put":{"tags":["Customer"],"summary":"Update the Branch of a Customer","description":"Update the Branch of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerBranch","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["branch_id"],"properties":{"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"branch_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/FishPort":{"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort List","description":"Get FishPort List.
\nPortfolio of fishbased values
\nProperty List:
\nMethodRouting settings example:
\n![http://www.example.com/id-docs/123/image.png](\"http://www.example.com/id-docs/123/image.png\"){kind=link}
{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FishPort"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /FishPort?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new FishPort.
\nPortfolio of fishbased values
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FishPort"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createFishPort_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish","number"],"properties":{"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"fish":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port"],"properties":{"fish_port":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port_id","fish","number"],"properties":{"fish_port_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/transaction-types":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2"],"summary":"Get Transaction Types at Bank","description":"Get Transaction Types for the bank specified by BANK_ID:
\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nvalue: 5987953
\n","operationId":"OBPv2.0.0-getTransactionTypes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_types"],"properties":{"transaction_types":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","short_code","bank_id","summary","charge","id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_types":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/users/{provider}/{username}/locks":{"post":{"tags":["User"],"summary":"Lock the user","description":"Lock a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON request body fields:
\nJSON response body fields:
\nlast_lock_date: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv5.1.0-lockUserByProviderAndUsername","parameters":[{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"username","in":"path","description":"The USERNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type_of_lock","last_lock_date","user_id"],"properties":{"type_of_lock":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_lock_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type_of_lock":{"type":"string"},"last_lock_date":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/CovidAPIDays/{covidapidaysid}":{"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays by id","description":"Get CovidAPIDays by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"CovidAPIDays"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays_","parameters":[{"name":"covidapidaysid","in":"path","description":"The COVIDAPIDAYSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days"],"properties":{"covid_api_days":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days_id","name","number"],"properties":{"covid_api_days_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Update CovidAPIDays","description":"Update CovidAPIDays.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"CovidAPIDays"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateCovidAPIDays_","parameters":[{"name":"covidapidaysid","in":"path","description":"The COVIDAPIDAYSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days"],"properties":{"covid_api_days":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days_id","name","number"],"properties":{"covid_api_days_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Delete CovidAPIDays by id","description":"Delete CovidAPIDays by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"CovidAPIDays"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteCovidAPIDays_","parameters":[{"name":"covidapidaysid","in":"path","description":"The COVIDAPIDAYSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days"],"properties":{"covid_api_days":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days_id","name","number"],"properties":{"covid_api_days_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/metadata/tags":{"get":{"tags":["Account-Metadata","Account"],"summary":"Get tags on account","description":"Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
\nUser 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\ntags: Create-My-User
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getTagsForViewOnAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags"],"properties":{"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Account-Metadata","Account"],"summary":"Create a tag on account","description":"Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-addTagForViewOnAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/endpoints/json-schema-validations":{"get":{"tags":["JSON-Schema-Validation"],"summary":"Get all JSON Schema Validations - public","description":"Get all JSON Schema Validations - public.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv6.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","operationId":"OBPv4.0.0-getAllJsonSchemaValidationsPublic","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema_validations"],"properties":{"json_schema_validations":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema","operation_id"],"properties":{"json_schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"json_schema_validations":{"type":"array","items":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/management/system-dynamic-entities/{dynamicentityid}":{"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update System Level Dynamic Entity","description":"Update a system level Dynamic Entity.
\nThis v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.
Request format:
\n{\n "entity_name": "customer_preferences",\n "has_personal_entity": true,\n "has_public_access": false,\n "has_community_access": false,\n "personal_requires_role": false,\n "schema": {\n "description": "User preferences updated",\n "required": ["theme"],\n "properties": {\n "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference"},\n "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"},\n "notifications_enabled": {"type": "boolean", "example": "true", "description": "Whether to send notifications"}\n }\n }\n}\nNote:
\n* The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
\n* Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
\n* Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
\n* Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
\n* Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-updateSystemDynamicEntity","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","has_personal_entity","entity_name","has_public_access"],"properties":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"has_personal_entity":{"type":"boolean"},"entity_name":{"type":"string"},"has_public_access":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustrans/{sustransid}":{"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans by id","description":"Get sustrans by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"sustrans"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSinglesustrans_","parameters":[{"name":"sustransid","in":"path","description":"The SUSTRANSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans"],"properties":{"sustrans":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans_id","name","number"],"properties":{"sustrans_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Update sustrans","description":"Update sustrans.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"sustrans"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updatesustrans_","parameters":[{"name":"sustransid","in":"path","description":"The SUSTRANSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans"],"properties":{"sustrans":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans_id","name","number"],"properties":{"sustrans_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Delete sustrans by id","description":"Delete sustrans by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"sustrans"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deletesustrans_","parameters":[{"name":"sustransid","in":"path","description":"The SUSTRANSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans"],"properties":{"sustrans":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans_id","name","number"],"properties":{"sustrans_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/personal-data-fields":{"get":{"tags":["User","User-Attribute","Attribute"],"summary":"Get Personal Data Fields","description":"Get Personal Data Fields for the currently authenticated user.
\nReturns Personal Data Fields (IsPersonal=true) that are managed by the user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-getPersonalDataFields","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_attributes"],"properties":{"user_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"user_attributes":{"type":"array","items":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["User","User-Attribute","Attribute"],"summary":"Create Personal Data Field","description":"Create a Personal Data Field for the currently authenticated user.
\nPersonal Data Fields (IsPersonal=true) are managed by the user themselves and do not require special roles.
\nThis data is not available in ABAC rules for privacy reasons.
For non-personal attributes that can be used in ABAC rules, see the /users/USER_ID/attributes endpoints.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or "DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-createPersonalDataField","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system-views/{viewid}/permissions":{"post":{"tags":["View-System"],"summary":"Add Permission to a System View","description":"Add Permission to a System View.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON request body fields:
\npermission_name: permission_name
\nextra_data: extra_data
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","operationId":"OBPv5.1.0-addSystemViewPermission","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["extra_data","permission_name"],"properties":{"extra_data":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"permission_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"extra_data":{"type":"array","items":{"type":"string"}},"permission_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/my/consents":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get My Consents at Bank","description":"This endpoint gets the Consents created by a current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\n\n","operationId":"OBPv5.1.0-getMyConsentsByBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consents"],"properties":{"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","api_standard","consumer_id","last_usage_date","consent_id","last_action_date","consent_reference_id","jwt_payload","status","jwt","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt_payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["aud","views","nbf","exp","iss","iat","access","createdByUserId","email","jti","name","request_headers","entitlements","sub"],"properties":{"nbf":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_headers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["values","name"],"properties":{"values":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"jti":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"exp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"createdByUserId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"iat":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sub":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"aud":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iss":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["availableAccounts","transactions","accounts","balances"],"properties":{"availableAccounts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"consent_reference_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"status":{"type":"string"},"jwt":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/banks/{bankid}/cards":{"get":{"tags":["Card"],"summary":"Get Cards for the specified bank","description":"Should be able to filter on the following fields
\neg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
\n1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
\n2 account_id should be valid account_id , otherwise, it will return an empty card list.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\n\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","operationId":"OBPv3.1.0-getCardsForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["cards"],"properties":{"cards":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["card_number","enabled","pin_reset","allows","collected","on_hot_list","card_type","replacement","name_on_card","account","expires_date","technology","posted","customer_id","bank_id","card_id","issue_number","serial_number","cancelled","valid_from_date","networks"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cancelled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_hot_list":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"allows":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"technology":{"type":"string"},"posted":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"card_id":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"valid_from_date":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/atms/{atmid}/attributes/{atmattributeid}":{"get":{"tags":["ATM","ATM-Attribute","Attribute"],"summary":"Get ATM Attribute By ATM_ATTRIBUTE_ID","description":"Get ATM Attribute By ATM_ATTRIBUTE_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-getAtmAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}},{"name":"atmattributeid","in":"path","description":"The ATMATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["ATM","ATM-Attribute","Attribute"],"summary":"Update ATM Attribute","description":"Update ATM Attribute.
\nUpdate an ATM Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-updateAtmAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}},{"name":"atmattributeid","in":"path","description":"The ATMATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value","is_active","type"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["ATM","ATM-Attribute","Attribute"],"summary":"Delete ATM Attribute","description":"Delete ATM Attribute
\nDelete a Atm Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteAtmAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}},{"name":"atmattributeid","in":"path","description":"The ATMATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/attributes":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attributes","description":"Get Customer Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getCustomerAttributes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attributes"],"properties":{"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers/{consumerid}/consumer/name":{"put":{"tags":["Consumer"],"summary":"Update Consumer Name","description":"Update an existing name for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-updateConsumerName","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name"],"properties":{"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"app_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-policies":{"get":{"tags":["ABAC"],"summary":"Get ABAC Policies","description":"Get the list of allowed ABAC policy names.
\nABAC rules are organized by policies. Each rule must have at least one policy assigned.
\nRules can have multiple policies (comma-separated). This endpoint returns the list of
\nstandardized policy names that should be used when creating or updating rules.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\npolicies: policies
\npolicy: policy
\n","operationId":"OBPv6.0.0-getAbacPolicies","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policies"],"properties":{"policies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","description"],"properties":{"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"policies":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string"},"description":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{userid}/account-access":{"get":{"tags":["Account"],"summary":"Get Account Access by USER_ID","description":"Get Account Access by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","operationId":"OBPv5.1.0-getAccountAccessByUserId","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/historical/transactions ":{"post":{"tags":["Transaction-Request"],"summary":"Save Historical Transactions ","description":"Import the historical transactions.
\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.
\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty
\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.
\nSo:
\nWhen you need the account to account, just omit counterparty_id field.eg:
\n{
\n"from": {
\n"bank_id": "gh.29.uk",
\n"account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
When you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"counterparty_id": "26392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
or, you can counterparty to account
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntype:
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","operationId":"OBPv3.1.0-saveHistoricalTransaction","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","completed","description","from","to","value","charge_policy","posted"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"completed":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","completed","from","transaction_request_type","to","value","charge_policy","transaction_id","posted"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"posted":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/consents/{implicit}":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent (IMPLICIT)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nExamples:
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
URL Parameters:
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-createConsentImplicit","parameters":[{"name":"implicit","in":"path","description":"The IMPLICIT identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlements","everything","valid_from","views","consumer_id","time_to_live"],"properties":{"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consent_id","status","jwt"],"properties":{"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/consumers/{consumerid}/consumer/call-limits":{"put":{"tags":["Consumer","Rate-Limits"],"summary":"Set Rate Limits / Call Limits per Consumer","description":"Set the API rate limits / call limits for a Consumer:
\nRate limiting can be set:
\nPer Second
\nPer Minute
\nPer Hour
\nPer Week
\nPer Month
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nfrom_date: 1100-01-01T01:01:01.000Z
\n\n\n\n\n\n\nto_date: 1100-01-01T01:01:01.000Z
\napi_name: api_name
\n\nbank_id: gh.29.uk
\n","operationId":"OBPv4.0.0-callsLimit","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","per_week_call_limit","per_day_call_limit","per_second_call_limit","per_month_call_limit","per_hour_call_limit","per_minute_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","per_week_call_limit","per_day_call_limit","per_second_call_limit","per_month_call_limit","per_hour_call_limit","per_minute_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/cache/namespaces/invalidate":{"post":{"tags":["Cache","System","API"],"summary":"Invalidate Cache Namespace","description":"Invalidates a cache namespace by incrementing its version counter.
\nThis provides instant cache invalidation without deleting individual keys.
\nIncrementing the version counter makes all keys with the old version unreachable.
Available namespace IDs: call_counter, rl_active, rd_localised, rd_dynamic,
\nrd_static, rd_all, swagger_static, connector, metrics_stable, metrics_recent, abac_rule
Use after updating rate limits, translations, endpoints, or CBS data.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nnamespace_id: namespace_id
\nJSON response body fields:
\nnamespace_id: namespace_id
\nnew_version: new_version
\nold_version: old_version
\n\n","operationId":"OBPv6.0.0-invalidateCacheNamespace","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["namespace_id"],"properties":{"namespace_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"namespace_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["namespace_id","new_version","status","old_version"],"properties":{"namespace_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"new_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"old_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"namespace_id":{"type":"string"},"new_version":{"type":"integer"},"status":{"type":"string"},"old_version":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/management/banks/{bankid}/cards":{"post":{"tags":["Card"],"summary":"Create Card","description":"Create Card at bank specified by BANK_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nallows: [credit,debit,cash_withdrawal]
\nbrand: Visa
\ncard_number: 364435172576215
\ncard_type: Credit
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: false
\nexpires_date: 2021-01-27
\nissue_number: 1
\nname_on_card: SusanSmith
\n\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\ncollected: 2020-01-27
\nposted: 2020-01-27
\n\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\nbrand: Visa
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncvv: 123
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","operationId":"OBPv5.0.0-addCardForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["posted","card_number","enabled","allows","technology","card_type","name_on_card","expires_date","customer_id","pin_reset","collected","replacement","brand","issue_number","serial_number","networks","account_id","valid_from_date"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"brand":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"posted":{"type":"string","format":"date-time"},"card_number":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"collected":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"brand":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"account_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["card_number","cvv","enabled","pin_reset","allows","technology","collected","on_hot_list","card_type","replacement","name_on_card","account","expires_date","posted","customer_id","bank_id","brand","card_id","issue_number","serial_number","networks","cancelled","valid_from_date"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"cvv":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"brand":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cancelled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_hot_list":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"card_number":{"type":"string"},"cvv":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"brand":{"type":"string"},"card_id":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"cancelled":{"type":"boolean"},"valid_from_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test1/TEST1_ID":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 by id","description":"Get test1 by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingletest1_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1"],"properties":{"test1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1_id","name","number"],"properties":{"test1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Update test1","description":"Update test1.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updatetest1_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1"],"properties":{"test1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1_id","name","number"],"properties":{"test1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Delete test1 by id","description":"Delete test1 by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deletetest1_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1"],"properties":{"test1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1_id","name","number"],"properties":{"test1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/cascading/banks/{bankid}/accounts/{accountid}/transactions/{transactionid}":{"delete":{"tags":["Transaction"],"summary":"Delete Transaction Cascade","description":"Delete a Transaction Cascade specified by TRANSACTION_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteTransactionCascade","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/diagnostics/dynamic-entities/orphaned-records":{"delete":{"tags":["Dynamic-Entity","API"],"summary":"Cleanup Orphaned Dynamic Entity Records","description":"Delete orphaned dynamic entity data records.
\nOrphaned records are rows in the DynamicData table whose entityName/bankId combination
\nhas no matching Dynamic Entity definition. These can accumulate when entity definitions
\nare deleted but their data records are not cleaned up.
This endpoint first identifies all orphaned records (using the same detection logic as
\nGET /management/diagnostics/dynamic-entities), then deletes them.
Response Format:
\n* deleted_orphaned_entities - List of orphaned entity groups that were deleted, each with:
\n* entity_name - Name of the orphaned entity
\n* bank_id - Bank ID (or empty string for system-level)
\n* record_count - Number of records that were deleted for this entity group
\n* total_records_deleted - Total count of all deleted records
Authentication is Required
\nRequired Role: CanCleanupOrphanedDynamicEntityRecords
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-cleanupOrphanedDynamicEntityRecords","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["deleted_orphaned_entities","total_records_deleted"],"properties":{"deleted_orphaned_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["record_count","bank_id","entity_name"],"properties":{"record_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"total_records_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"deleted_orphaned_entities":{"type":"array","items":{"type":"object","properties":{"record_count":{"type":"integer"},"bank_id":{"type":"string"},"entity_name":{"type":"string"}}}},"total_records_deleted":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers/{consumerid}/consumer/redirect_url":{"put":{"tags":["Consumer"],"summary":"Update Consumer RedirectURL","description":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv5.1.0-updateConsumerRedirectURL","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["redirect_url"],"properties":{"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"redirect_url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name","enabled","created_by_user_id","created_by_user","description","developer_email","created","consumer_id","redirect_url","app_type"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-message-docs/{dynamicmessagedocid}":{"get":{"tags":["Dynamic-Message-Doc"],"summary":"Get Dynamic Message Doc","description":"Get a Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-getDynamicMessageDoc","parameters":[{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Dynamic-Message-Doc"],"summary":"Update Dynamic Message Doc","description":"Update a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-updateDynamicMessageDoc","parameters":[{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Message-Doc"],"summary":"Delete Dynamic Message Doc","description":"Delete a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteDynamicMessageDoc","parameters":[{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/Odometer":{"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer List","description":"Get Odometer List.
\nVerify odometer information for flexible contracts.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"Odometer"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /Odometer?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Odometer.
\nVerify odometer information for flexible contracts.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"Odometer"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createOdometer_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","odometer"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"odometer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["odometer_id","name","number"],"properties":{"odometer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/checkbook/orders":{"get":{"tags":["Account"],"summary":"Get Checkbook orders","description":"Get all checkbook orders
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\naccount_type: AC
\n\nbank_id: gh.29.uk
\n\n\n\n\n\norder_date: 2020-01-27
\n\n\nscheme: OBP
\n\n\n","operationId":"OBPv3.1.0-getCheckbookOrders","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account","orders"],"properties":{"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","account_type","bank_id","branch_routings","account_id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"orders":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["order"],"properties":{"order":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["shipping_code","number_of_checkbooks","status","order_id","distribution_channel","first_check_number","order_date"],"properties":{"order_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number_of_checkbooks":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"first_check_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"order_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"shipping_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"distribution_channel":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"branch_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_id":{"type":"string"}}},"orders":{"type":"array","items":{"type":"object","properties":{"order":{"type":"object","properties":{"shipping_code":{"type":"string"},"number_of_checkbooks":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string"},"distribution_channel":{"type":"string"},"first_check_number":{"type":"string"},"order_date":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system/log-cache/all":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get All Level Log Cache","description":"Returns logs of all levels from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/all?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheAllEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/resource-docs/{apiversion}/openapi":{"get":{"tags":["Documentation","API"],"summary":"Get OpenAPI 3.1 documentation","description":"Returns documentation about the RESTful resources on this server in OpenAPI 3.1 format.
\nAPI_VERSION is the version you want documentation about e.g. v6.0.0
\nYou may filter this endpoint using the following optional query parameters:
\ntags - Filter by endpoint tags (comma-separated list)
\n• Example: ?tags=Account,Bank or ?tags=Account-Firehose
\n• All endpoints are given one or more tags which are used for grouping
\n• Empty values will return error OBP-10053
functions - Filter by function names (comma-separated list)
\n• Example: ?functions=getBanks,bankById
\n• Each endpoint is implemented in the OBP Scala code by a 'function'
\n• Empty values will return error OBP-10054
content - Filter by endpoint type
\n• Values: static, dynamic, all (case-insensitive)
\n• static: Only show static/core API endpoints
\n• dynamic: Only show dynamic/custom endpoints
\n• all: Show both static and dynamic endpoints (default)
\n• Invalid values will return error OBP-10052
locale - Language for localized documentation
\n• Example: ?locale=en_GB or ?locale=es_ES
\n• Supported locales: en_GB, es_ES, ro_RO
\n• Invalid locales will return error OBP-10041
api-collection-id - Filter by API collection UUID
\n• Example: ?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
\n• Returns only endpoints belonging to the specified collection
\n• Empty values will return error OBP-10055
This endpoint generates OpenAPI 3.1 compliant documentation with modern JSON Schema support.
\nFor YAML format, use the corresponding endpoint: /resource-docs/API_VERSION/openapi.yaml
\nSee the Resource Doc endpoint for more information.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nBasic usage:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi
Filter by tags:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose
Filter by content type:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic
Filter by functions:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById
Combine multiple parameters:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&tags=Account-Firehose
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&functions=getBanks,bankById
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&locale=en_GB&tags=Account
Filter by API collection:
\nhttps://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.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv1.4.0-getResourceDocsOpenAPI31","parameters":[{"name":"apiversion","in":"path","description":"The APIVERSION identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/endpoints/authentication-type-validations":{"get":{"tags":["Authentication-Type-Validation"],"summary":"Get all Authentication Type Validations - public","description":"Get all Authentication Type Validations - public.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getAllAuthenticationTypeValidationsPublic","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authentication_types_validations"],"properties":{"authentication_types_validations":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authTypes","operationId"],"properties":{"authTypes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"authentication_types_validations":{"type":"array","items":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/account":{"get":{"tags":["Account"],"summary":"Get Account by Id (Full)","description":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
\nMore details about the data moderation by the view here.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-getPrivateAccountByIdFull","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","tags","label","number","bank_id","owners","id","views_available","balance","account_attributes"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/provider/{provider}/username/{username}":{"get":{"tags":["User"],"summary":"Get User by USERNAME","description":"Get user by PROVIDER and USERNAME
\nGet a User by their authentication provider and username.
\nURL Parameters:
\nImportant: The PROVIDER parameter can contain special characters like slashes and colons.
\nFor example, if the provider is "http://127.0.0.1:8080", the full URL would be:
GET /obp/v5.1.0/users/provider/http://127.0.0.1:8080/username/obpstripe
The API will correctly parse the provider value even with these special characters.
\nTo find valid providers, use the GET /obp/v6.0.0/providers endpoint (available in API version 6.0.0).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","operationId":"OBPv5.1.0-getUserByProviderAndUsername","parameters":[{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"username","in":"path","description":"The USERNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","last_marketing_agreement_signed_date","provider_id","agreements","entitlements","is_deleted","is_locked","username","views","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"is_locked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"last_marketing_agreement_signed_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"agreements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","text"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.2.0/banks/{bankid}/fx":{"put":{"tags":["FX"],"summary":"Create Fx","description":"Create or Update Fx for the Bank.
\nExample:
\n“from_currency_code”:“EUR”,
\n“to_currency_code”:“USD”,
\n“conversion_value”: 1.136305,
\n“inverse_conversion_value”: 1 / 1.136305 = 0.8800454103431737,
Thus 1 Euro = 1.136305 US Dollar
\nand
\n1 US Dollar = 0.8800 Euro
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\n\n\nto_currency_code: EUR
\n","operationId":"OBPv2.2.0-createFx","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["effective_date","conversion_value","from_currency_code","bank_id","inverse_conversion_value","to_currency_code"],"properties":{"inverse_conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"effective_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"conversion_value":{"type":"number"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"to_currency_code":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["effective_date","conversion_value","from_currency_code","bank_id","inverse_conversion_value","to_currency_code"],"properties":{"inverse_conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"effective_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"conversion_value":{"type":"number"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"to_currency_code":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/supported-languages":{"put":{"tags":["ATM"],"summary":"Update ATM Supported Languages","description":"Update ATM Supported Languages.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nsupported_languages: ["es","fr","de"]
\n","operationId":"OBPv4.0.0-updateAtmSupportedLanguages","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["supported_languages"],"properties":{"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"supported_languages":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["supported_languages","atm_id"],"properties":{"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"supported_languages":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/connector-method-names":{"get":{"tags":["Connector-Method","System","Method-Routing","API"],"summary":"Get Connector Method Names","description":"Get the list of all available connector method names.
\nThese are the method names that can be used in Method Routing configuration.
\nThe data comes from scanning the actual Scala connector code at runtime using reflection, NOT from a database or configuration file.
\nThe endpoint:
\n1. Reads the connector name from props (e.g., connector=mapped)
\n2. Gets the connector instance (e.g., LocalMappedConnector, KafkaConnector, StarConnector)
\n3. Uses Scala reflection to scan all public methods that override the base Connector trait
\n4. Filters for valid connector methods (public, has parameters, overrides base trait)
\n5. Returns the method names as a sorted list
Depends on your connector property:
\n* connector=mapped → Returns methods from LocalMappedConnector
\n* connector=kafka_vSept2018 → Returns methods from KafkaConnector
\n* connector=star → Returns methods from StarConnector
\n* connector=rest_vMar2019 → Returns methods from RestConnector
The list only changes when:
\n* Code is deployed with new/modified connector methods
\n* The connector property is changed to point to a different connector
This endpoint uses caching (default: 1 hour) because Scala reflection is expensive.
\nConfigure via: getConnectorMethodNames.cache.ttl.seconds=3600
Use this endpoint to discover which connector methods are available when configuring Method Routing.
\nThese method names are different from API endpoint operation IDs (which you get from /resource-docs).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetSystemConnectorMethodNames entitlement is required.
\nJSON response body fields:
\nconnector_method_names: connector_method_names
\n","operationId":"OBPv6.0.0-getConnectorMethodNames","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_method_names"],"properties":{"connector_method_names":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"connector_method_names":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID":{"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 by id","description":"Get D-Entity1 by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"D-Entity1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleD-Entity1_gh.29.uk","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","d-entity1"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"d-entity1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["d-entity1_id","name","number"],"properties":{"d-entity1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update D-Entity1","description":"Update D-Entity1.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"D-Entity1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateD-Entity1_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","d-entity1"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"d-entity1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["d-entity1_id","name","number"],"properties":{"d-entity1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete D-Entity1 by id","description":"Delete D-Entity1 by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"D-Entity1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteD-Entity1_gh.29.uk","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","d-entity1"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"d-entity1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["d-entity1_id","name","number"],"properties":{"d-entity1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/MarchHare/{marchhareid}":{"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare by id","description":"Get MarchHare by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"MarchHare"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleMarchHare_gh.29.uk","parameters":[{"name":"marchhareid","in":"path","description":"The MARCHHAREID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","march_hare"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"march_hare":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["march_hare_id","name","number"],"properties":{"march_hare_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update MarchHare","description":"Update MarchHare.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"MarchHare"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateMarchHare_gh.29.uk","parameters":[{"name":"marchhareid","in":"path","description":"The MARCHHAREID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","march_hare"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"march_hare":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["march_hare_id","name","number"],"properties":{"march_hare_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete MarchHare by id","description":"Delete MarchHare by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"MarchHare"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteMarchHare_gh.29.uk","parameters":[{"name":"marchhareid","in":"path","description":"The MARCHHAREID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","march_hare"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"march_hare":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["march_hare_id","name","number"],"properties":{"march_hare_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/consents/{consentid}/challenge":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Answer Consent Challenge","description":"An OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
This endpoint is used to confirm a Consent previously created.
\nThe User must supply a code that was sent out of band (OOB) for example via an SMS.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON request body fields:
\n\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv3.1.0-answerConsentChallenge","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["answer"],"properties":{"answer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"answer":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consent_id","status","jwt"],"properties":{"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/{userid}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for User","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getEntitlements","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_id","bank_id","role_name","user_id"],"properties":{"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/consumer/vrp-consent-requests":{"post":{"tags":["Consent","VRP","Transaction-Request"],"summary":"Create Consent Request VRP","description":"This endpoint is used to begin the process of creating a consent that may be used for Variable Recurring Payments (VRPs).
\nVRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis.
\nOnce granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the
\nCounterparty Limits linked to this particular consent are respected.
Client, Consumer or Application Authentication is mandatory for this endpoint.
\ni.e. the caller of this endpoint is the API Client, Consumer or Application rather than a specific User.
\nAt the end of the process the following objects are created in OBP or connected backend systems:
\n- An automatically generated View which controls access.
\n- A Counterparty that is the Beneficiary of the Variable Recurring Payments. The Counterparty specifies the Bank Account number or other routing address.
\n- Limits for the Counterparty which constrain the amount of money that can be sent to it in various periods (yearly, monthly, weekly).
The Account holder may modify the Counterparty or Limits e.g. to increase or decrease the maximum possible payment amounts or the frequencey of the payments.
\nIn the case of a public client we use the client_id and private key to obtain an access token, otherwise we use the client_id and client_secret.
\nThe obtained access token is used in the HTTP Authorization header of the request as follows:
Example:
\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0
After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint.
Application Access is Required. The Application must be authenticated.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\n\n\n\ncounterparty_name: John Smith Ltd.
\ncurrency: EUR
\nfrom_account: from_account
\nlimit: 100
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nscheme: OBP
\nto_account: to_account
\n\n\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","operationId":"OBPv5.1.0-createVRPConsentRequest","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_account","phone_number","email","from_account","time_to_live","valid_from"],"properties":{"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routing","account_routing","branch_routing"],"properties":{"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routing","counterparty_name","limit","account_routing","branch_routing"],"properties":{"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"counterparty_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","max_yearly_amount","max_number_of_transactions"],"properties":{"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"to_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"counterparty_name":{"type":"string"},"limit":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"phone_number":{"type":"string"},"email":{"type":"string"},"from_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"time_to_live":{"type":"integer"},"valid_from":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumer_id","payload","consent_request_id"],"properties":{"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["from_account","to_account","valid_from","time_to_live"],"properties":{"from_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routing","account_routing","branch_routing"],"properties":{"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routing","account_routing","branch_routing","limit"],"properties":{"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_monthly_amount","max_number_of_yearly_transactions","max_yearly_amount","currency","max_single_amount","max_number_of_monthly_transactions"],"properties":{"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"valid_from":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consumer_id":{"type":"string"},"payload":{"type":"object","properties":{"from_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}},"to_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"limit":{"type":"object","properties":{"max_monthly_amount":{"type":"integer"},"max_number_of_yearly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"integer"},"currency":{"type":"string"},"max_single_amount":{"type":"integer"},"max_number_of_monthly_transactions":{"type":"integer"}}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}},"consent_request_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v3.1.0/management/metrics/top-consumers":{"get":{"tags":["Metric"],"summary":"Get Top Consumers","description":"Get metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.
\nShould be able to filter on the following fields
\ne.g.: /management/metrics/top-consumers?from_date=1970-01-01T00:00:00.000Z&to_date=2026-02-25T15:15:25.779Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n&limit=100
1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z
\n2 to_date (defaults to the current date) eg:to_date=2026-02-25T15:15:25.779Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\n16 limit (for pagination: defaults to 50) eg:limit=200
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\n","operationId":"OBPv3.1.0-getMetricsTopConsumers","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["top_consumers"],"properties":{"top_consumers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["count","developer_email","consumer_id","app_name"],"properties":{"count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"top_consumers":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"app_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/metadata/tags/{tagid}":{"delete":{"tags":["Account-Metadata","Account"],"summary":"Delete a tag on account","description":"Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteTagForViewOnAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"tagid","in":"path","description":"The TAGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user_customer_links/customers/{customerid}":{"get":{"tags":["Customer"],"summary":"Get User Customer Links by Customer","description":"Get User Customer Links by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getUserCustomerLinksByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_customer_links"],"properties":{"user_customer_links":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_customer_link_id","customer_id","is_active","date_inserted","user_id"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_inserted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_customer_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"user_customer_links":{"type":"array","items":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"date_inserted":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/authentication-type-validations":{"get":{"tags":["Authentication-Type-Validation"],"summary":"Get all Authentication Type Validations","description":"Get all Authentication Type Validations.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getAllAuthenticationTypeValidations","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authentication_types_validations"],"properties":{"authentication_types_validations":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authTypes","operationId"],"properties":{"authTypes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"authentication_types_validations":{"type":"array","items":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/customers-minimal":{"get":{"tags":["Customer","User"],"summary":"Get Customers Minimal at Any Bank","description":"Get Customers Minimal at Any Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n","operationId":"OBPv4.0.0-getCustomersMinimalAtAnyBank","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","bank_id"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/my/banks/{bankid}/accounts/{accountid}/transactions":{"get":{"tags":["Transaction","Account Information Service (AIS)","Account","PSD2"],"summary":"Get Transactions for Account (Core)","description":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\n\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\nposted: 2020-01-27
\nscheme: OBP
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nvalue: 5987953
\n","operationId":"OBPv3.0.0-getCoreTransactionsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["details","id","transaction_attributes","this_account","other_account"],"properties":{"this_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","bank_routing","holders","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"holders":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","description","posted","new_balance","completed","value"],"properties":{"new_balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"other_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","bank_routing","holder","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transaction_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"id":{"type":"string"},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/consent/current":{"delete":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Revoke Consent used in the Current Call","description":"Revoke Consent specified by Consent-Id at Request Header
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-selfRevokeConsent","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/oidc/clients/{clientid}":{"get":{"tags":["OIDC","Consumer","OAuth"],"summary":"Get OIDC Client","description":"Gets an OIDC/OAuth2 client's metadata by client_id.
\nReturns client information including name, consumer_id, redirect_uris, and enabled status.
\nThis endpoint does not verify the client secret - use POST /oidc/clients/verify for authentication.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCLIENT_ID: CLIENT_ID
\nJSON response body fields:
\nclient_id: client_id
\nclient_name: client_name
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: false
\nredirect_uris: redirect_uris
\n","operationId":"OBPv6.0.0-getOidcClient","parameters":[{"name":"clientid","in":"path","description":"The CLIENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","redirect_uris","consumer_id","client_id","client_name"],"properties":{"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"client_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"client_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_uris":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"redirect_uris":{"type":"array","items":{"type":"string"}},"consumer_id":{"type":"string"},"client_id":{"type":"string"},"client_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/transaction-request":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attribute Definition","description":"Get Transaction Request Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getTransactionRequestAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Create or Update Transaction Request Attribute Definition","description":"Create or Update Transaction Request Attribute Definition
\nThe category field must be TransactionRequest
\nThe type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateTransactionRequestAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/obp.testing.01/ObpActivity/{obpactivityid}":{"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity by id","description":"Get ObpActivity by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"ObpActivity"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleObpActivity_obp.testing.01","parameters":[{"name":"obpactivityid","in":"path","description":"The OBPACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","obp_activity"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"obp_activity":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["obp_activity_id","name","username","created_date"],"properties":{"obp_activity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Update ObpActivity","description":"Update ObpActivity.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"ObpActivity"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateObpActivity_obp.testing.01","parameters":[{"name":"obpactivityid","in":"path","description":"The OBPACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","username","created_date"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","obp_activity"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"obp_activity":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["obp_activity_id","name","username","created_date"],"properties":{"obp_activity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Delete ObpActivity by id","description":"Delete ObpActivity by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"ObpActivity"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteObpActivity_obp.testing.01","parameters":[{"name":"obpactivityid","in":"path","description":"The OBPACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","obp_activity"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"obp_activity":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["obp_activity_id","name","username","created_date"],"properties":{"obp_activity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/my/test_daniel707/TEST_DANIEL707_ID":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 by id","description":"Get My test_daniel707 by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleMytest_daniel707_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update My test_daniel707","description":"Update My test_daniel707.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateMytest_daniel707_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete My test_daniel707 by id","description":"Delete My test_daniel707 by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteMytest_daniel707_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.3.0/cards":{"get":{"tags":["Card"],"summary":"Get cards for the current user","description":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\n\ncollected: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","operationId":"OBPv1.3.0-getCards","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["cards"],"properties":{"cards":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["technology","name_on_card","enabled","pin_reset","collected","on_hot_list","replacement","account","expires_date","posted","networks","bank_id","bank_card_number","issue_number","serial_number","cancelled","allows","valid_from_date"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cancelled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"bank_card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"on_hot_list":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"technology":{"type":"string"},"name_on_card":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"bank_card_number":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"valid_from_date":{"type":"string","format":"date-time"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/customers/customer-number-query/overview-flat":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer Overview Flat","description":"Gets the Customer Overview Flat specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncontract_code: contract_code
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate_of_birth: 2018-03-09
\n\nlabel: My Account
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\nscheme: OBP
\ntitle: Dr.
\ntype:
\nvalue: 5987953
\nbranch_code: branch_code
\ncancellation_date: cancellation_date
\ncontract_code: contract_code
\ncontracts: contracts
\nform_of_payment: form_of_payment
\ninstrument_status_code: instrument_status_code
\ninstrument_status_definition: instrument_status_definition
\ninterest_amount: interest_amount
\ninterest_rate: interest_rate
\nis_substituted: is_substituted
\nissuance_amount: issuance_amount
\nmaturity_date: maturity_date
\nopening_date: opening_date
\npayment_method: payment_method
\nproduct_description: product_description
\nrenewal_date: renewal_date
\nterm: term
\n","operationId":"OBPv5.0.0-getCustomerOverviewFlat","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attributes","email","accounts","customer_id","bank_id","customer_number","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","contracts","product_code","label","balance","branch_id","account_attributes","account_id"],"properties":{"contracts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["payment_method","product_code","contract_code"],"properties":{"payment_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contract_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","type","name","contract_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contract_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"email":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"contracts":{"type":"array","items":{"type":"object","properties":{"payment_method":{"type":"string"},"product_code":{"type":"string"},"contract_code":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consents":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consents","description":"This endpoint gets the Consents.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n1 limit (for pagination: defaults to 50) eg:limit=200
\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n3 consumer_id (ignore if omitted)
\n4 consent_id (ignore if omitted)
\n5 user_id (ignore if omitted)
\n6 status (ignore if omitted)
\n7 bank_id (ignore if omitted)
\n8 provider_provider_id (ignore if omitted)
\nprovider and provider_id values are separated by pipe char
\neg: provider_provider_id=http%3A%2F%2Flocalhost%3A7070%2Frealms%2Fmaster|7837ee9c-3446-4d8c-9b90-301a52b4851d
eg:/management/consents?consumer_id=78&limit=10&offset=10
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nnote: note
\nnumber_of_rows: number_of_rows
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nfrequency_per_day: frequency_per_day
\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\nprovider: ETHEREUM
\n\nremaining_requests: remaining_requests
\n\n","operationId":"OBPv5.1.0-getConsents","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number_of_rows","consents"],"properties":{"number_of_rows":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","created_by_user_id","api_standard","consumer_id","last_usage_date","last_action_date","consent_reference_id","jwt_payload","note","provider_id","status","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt_payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["aud","views","nbf","exp","iss","iat","access","createdByUserId","email","jti","name","request_headers","entitlements","sub"],"properties":{"nbf":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_headers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["values","name"],"properties":{"values":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"jti":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"exp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"createdByUserId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"iat":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sub":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"aud":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iss":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["availableAccounts","transactions","accounts","balances"],"properties":{"availableAccounts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_reference_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"note":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"number_of_rows":{"type":"integer"},"consents":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"note":{"type":"string"},"provider_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/data":{"put":{"tags":["Customer"],"summary":"Update the other data of a Customer","description":"Update the other data of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerData","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","face_image","employment_status","relationship_status","highest_education_attained"],"properties":{"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"employment_status":{"type":"string"},"relationship_status":{"type":"string"},"highest_education_attained":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/consents/{consentid}/user-update-request":{"put":{"tags":["Consent","Account Information Service (AIS)"],"summary":"Add User to a Consent","description":"This endpoint is used to add the User of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv4.0.0-addConsentUser","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system/log-cache/info":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Info Level Log Cache","description":"Returns INFO level logs from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/info?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheInfoEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/groups":{"get":{"tags":["Group"],"summary":"Get Groups","description":"Get all groups. Optionally filter by bank_id.
\nQuery parameters:
\n- bank_id (optional): Filter groups by bank. Use "null" or omit for system-level groups.
Requires either:
\n- CanGetGroupsAtAllBanks (for any/all groups)
\n- CanGetGroupsAtOneBank (for groups at specific bank with bank_id parameter)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ngroup_description: group_description
\ngroup_id: group_id
\ngroup_name: group_name
\ngroups: groups
\nis_enabled: is_enabled
\nlist_of_roles: list_of_roles
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-getGroups","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["groups"],"properties":{"groups":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_id","list_of_roles","bank_id","is_enabled","group_description"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"group_name":{"type":"string"},"group_id":{"type":"string"},"list_of_roles":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"is_enabled":{"type":"boolean"},"group_description":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Group"],"summary":"Create Group","description":"Create a new group of roles.
\nGroups can be either:
\n- System-level (bank_id = null) - requires CanCreateGroupAtAllBanks role
\n- Bank-level (bank_id provided) - requires CanCreateGroupAtOneBank role
A group contains a list of role names that can be assigned together.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ngroup_description: group_description
\ngroup_name: group_name
\nis_enabled: is_enabled
\nlist_of_roles: list_of_roles
\nbank_id: gh.29.uk
\nJSON response body fields:
\ngroup_description: group_description
\ngroup_id: group_id
\ngroup_name: group_name
\nis_enabled: is_enabled
\nlist_of_roles: list_of_roles
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-createGroup","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_description","bank_id","is_enabled","list_of_roles"],"properties":{"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_name":{"type":"string"},"group_description":{"type":"string"},"bank_id":{"type":"string"},"is_enabled":{"type":"boolean"},"list_of_roles":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_id","group_description","bank_id","is_enabled","list_of_roles"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_name":{"type":"string"},"group_id":{"type":"string"},"group_description":{"type":"string"},"bank_id":{"type":"string"},"is_enabled":{"type":"boolean"},"list_of_roles":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/balances":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Account Balances by BANK_ID","description":"Get the Balances for the Account specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","operationId":"OBPv5.1.0-getBankAccountsBalances","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","balances","account_routings","account_id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","amount","currency"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/InsurancePremium":{"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium List","description":"Get InsurancePremium List.
\nRetrive the premium for the customer.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePremium"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new InsurancePremium.
\nRetrive the premium for the customer.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePremium"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePremium_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_premium"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_premium":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_premium_id","name","number"],"properties":{"insurance_premium_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/users/{userid}":{"put":{"tags":["User"],"summary":"Validate a user","description":"Validate the User by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nlast_lock_date: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv5.1.0-validateUserByUserId","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type_of_lock","last_lock_date","user_id"],"properties":{"type_of_lock":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_lock_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type_of_lock":{"type":"string"},"last_lock_date":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Metadata","description":"Get metadata of one other account.
\nReturns 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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nmore_info: More information about this fee
\n\n\n\nprovider: ETHEREUM
\n\nuser:
\n","operationId":"OBPv1.2.1-getOtherAccountMetadata","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/management/historical/transactions":{"post":{"tags":["Transaction-Request"],"summary":"Create Historical Transactions ","description":"Create historical transactions at one Bank
\nUse this endpoint to create transactions between any two accounts at the same bank.
\nFrom account and to account must be at the same bank.
\nExample:
\n{
\n"from_account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"to_account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom_account_id: from_account_id
\nposted: 2020-01-27
\nto_account_id: to_account_id
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","operationId":"OBPv4.0.0-createHistoricalTransactionAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","from_account_id","completed","description","value","charge_policy","posted","to_account_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"from_account_id":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"},"to_account_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","completed","from","transaction_request_type","to","value","charge_policy","transaction_id","posted"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"posted":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/banks/{bankid}/cards/{cardid}/attribute":{"post":{"tags":["Card","Card-Attribute","Attribute"],"summary":"Create Card Attribute","description":"Create Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","operationId":"OBPv3.1.0-createCardAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"cardid","in":"path","description":"The CARDID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","bank_id","card_id","attribute_type","name","card_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type","enum"],"properties":{"type":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}}}},"card_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"card_id":{"type":"string"},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]},"name":{"type":"string"},"card_attribute_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/account/check/scheme/iban":{"post":{"tags":["Account"],"summary":"Validate and check IBAN","description":"Validate and check IBAN for errors
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\nJSON response body fields:
\n\nattributes: attribute value in form of (name, value)
\nbank:
\nbank_routings: bank routing in form of (scheme, address)
\nbranch: branch
\ncity:
\ncountry: Germany
\nis_valid: is_valid
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nscheme: OBP
\nvalue: 5987953
\n\n","operationId":"OBPv4.0.0-ibanChecker","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"address":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_valid","details"],"properties":{"is_valid":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["postcode","branch","attributes","address","bank_routings","city","country","bank","phone"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"is_valid":{"type":"boolean"},"details":{"type":"object","properties":{"postcode":{"type":"string"},"branch":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"address":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"city":{"type":"string"},"country":{"type":"string"},"bank":{"type":"string"},"phone":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/narrative":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction Narrative","description":"Returns the account owner description of the transaction moderated by the view.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-getTransactionNarrative","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"narrative":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction Narrative","description":"Updates the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateTransactionNarrative","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"narrative":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Narrative","description":"Creates a description of the transaction TRANSACTION_ID.
\nNote: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
\nIf 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.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addTransactionNarrative","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"narrative":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Narrative","description":"Deletes the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteTransactionNarrative","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/tags":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Tags","description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv1.2.1-getTagsForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Tag","description":"Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv1.2.1-addTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/diagnostics/dynamic-entities":{"get":{"tags":["Dynamic-Entity","API"],"summary":"Get Dynamic Entity Diagnostics","description":"Get diagnostic information about Dynamic Entities to help troubleshoot Swagger generation issues.
\nUse Case:
\nThis endpoint is particularly useful when:
\n* The Swagger endpoint (/obp/v6.0.0/resource-docs/OBPv6.0.0/swagger?content=dynamic) fails with errors like "expected boolean"
\n* The OBP endpoint (/obp/v6.0.0/resource-docs/OBPv6.0.0/obp?content=dynamic) works fine
\n* You need to identify which dynamic entity has malformed field definitions
What It Checks:
\nThis endpoint analyzes all dynamic entities (both system and bank level) for:
\n* Boolean fields with invalid example values (e.g., actual JSON booleans or invalid strings instead of "true" or "false")
\n* Malformed JSON in field definitions
\n* Fields that cannot be converted to their declared types
\n* Other validation issues that cause Swagger generation to fail
Response Format:
\nThe response contains:
\n* issues - List of issues found, each with:
\n* entity_name - Name of the problematic entity
\n* bank_id - Bank ID (or "SYSTEM_LEVEL" for system entities)
\n* field_name - Name of the problematic field
\n* example_value - The current (invalid) example value
\n* error_message - Description of what's wrong and how to fix it
\n* total_issues - Count of total issues found
\n* scanned_entities - List of all dynamic entities that were scanned (format: "EntityName (BANK_ID)" or "EntityName (SYSTEM)")
How to Fix Issues:
\n1. Identify the problematic entity from the diagnostic output
\n2. Update the entity definition using PUT /management/system-dynamic-entities/DYNAMIC_ENTITY_ID or PUT /management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID
\n3. For boolean fields, ensure the example value is either "true" or "false" (as strings)
\n4. Re-run this diagnostic to verify the fix
\n5. Check that the Swagger endpoint now works
Example Issue:
\n{\n "entity_name": "Customer",\n "bank_id": "gh.29.uk",\n "field_name": "is_active",\n "example_value": "malformed_value",\n "error_message": "Boolean field has invalid example value. Expected 'true' or 'false', got: 'malformed_value'"\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nRequired Role: CanGetDynamicEntityDiagnostics
If no issues are found, the response will contain an empty issues list with total_issues: 0, but scanned_entities will show which entities were checked.
Gets all Customers that are linked to me.
\nAuthentication via OAuth is required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv5.0.0-getMyCustomersAtAnyBank","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","customer_id","relationship_status","last_ok_date","bank_id","highest_education_attained","customer_number","credit_rating","legal_name","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/has-account-access":{"get":{"tags":["View-Custom","Account"],"summary":"Has Account Access","description":"Check whether the authenticated user has access to a specific view on a specific account.
\nReturns a boolean has_account_access along with the access_source (currently "ACCOUNT_ACCESS")
\nand the account_access_id (primary key of the AccountAccess record).
If the user does not have access, has_account_access is false and the other fields are empty strings.
Authentication is Required
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\naccess_source: access_source
\naccount_access_id: account_access_id
\nhas_account_access: has_account_access
\n","operationId":"OBPv6.0.0-hasAccountAccess","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["abac_rule_id","has_account_access","access_source","account_access_id"],"properties":{"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_account_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"access_source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"abac_rule_id":{"type":"string"},"has_account_access":{"type":"boolean"},"access_source":{"type":"string"},"account_access_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/attributes/{attributeid}":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attribute By Id","description":"Get Customer Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getCustomerAttributeById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"attributeid","in":"path","description":"The ATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/account":{"get":{"tags":["Account","Account-Attribute","Attribute"],"summary":"Get Account Attribute Definition","description":"Get Account Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getAccountAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Account","Account-Attribute","Attribute"],"summary":"Create or Update Account Attribute Definition","description":"Create or Update Account Attribute Definition
\nThe category field must be Account
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateAccountAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/credit-rating-and-source":{"put":{"tags":["Customer"],"summary":"Update the credit rating and source of a Customer","description":"Update the credit rating and source of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerCreditRatingAndSource","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["credit_source","credit_rating"],"properties":{"credit_source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"credit_source":{"type":"string"},"credit_rating":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/customers/{customerid}/kyc_checks":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Checks","description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","operationId":"OBPv2.0.0-getKycChecks","parameters":[{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["checks"],"properties":{"checks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["comments","customer_id","staff_user_id","bank_id","customer_number","date","id","satisfied","how","staff_name"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"how":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"satisfied":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/migrations":{"get":{"tags":["System","API"],"summary":"Get Database Migrations","description":"Get all database migration script logs.
\nThis endpoint returns information about all migration scripts that have been executed or attempted.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetMigrations entitlement is required.
\nJSON response body fields:
\ncommit_id: commit_id
\ncreated_at: created_at
\nduration_in_ms: duration_in_ms
\n\nis_successful: is_successful
\nmigration_script_log_id: migration_script_log_id
\nmigration_script_logs: migration_script_logs
\nname: ACCOUNT_MANAGEMENT_FEE
\nremark: remark
\nstart_date: 2020-01-27
\nupdated_at: updated_at
\n","operationId":"OBPv6.0.0-getMigrations","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["migration_script_logs"],"properties":{"migration_script_logs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["commit_id","updated_at","migration_script_log_id","created_at","is_successful","remark","duration_in_ms","name","end_date","start_date"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"commit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"migration_script_log_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"duration_in_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"remark":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"is_successful":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"migration_script_logs":{"type":"array","items":{"type":"object","properties":{"commit_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"migration_script_log_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"is_successful":{"type":"boolean"},"remark":{"type":"string"},"duration_in_ms":{"type":"integer"},"name":{"type":"string"},"end_date":{"type":"integer"},"start_date":{"type":"integer"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collections/{apicollectionname}/api-collection-endpoints":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_NAME.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-getMyApiCollectionEndpoints","parameters":[{"name":"apicollectionname","in":"path","description":"The APICOLLECTIONNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_endpoints"],"properties":{"api_collection_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Api-Collection"],"summary":"Create My Api Collection Endpoint","description":"Create Api Collection Endpoint.
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON request body fields:
\noperation_id: OBPv6.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-createMyApiCollectionEndpoint","parameters":[{"name":"apicollectionname","in":"path","description":"The APICOLLECTIONNAME identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/api/glossary":{"get":{"tags":["Documentation"],"summary":"Get Glossary of the API","description":"Get API Glossary
\nReturns the glossary of the API
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhtml: html format content
\n\ntitle: Dr.
\n","operationId":"OBPv3.0.0-getApiGlossary","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["glossary_items"],"properties":{"glossary_items":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","title"],"properties":{"description":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["html","markdown"],"properties":{"html":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"markdown":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"glossary_items":{"type":"array","items":{"type":"object","properties":{"description":{"type":"object","properties":{"html":{"type":"string"},"markdown":{"type":"string"}}},"title":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/users/password":{"post":{"tags":["User"],"summary":"Complete Password Reset","description":"Complete a password reset using the token received via email.
\nAuthentication is NOT Required.
\nAfter requesting a password reset email (via POST /management/user/reset-password-url or
\nPOST /users/password-reset-url), the user receives an email with a reset link containing a JWT token.
This endpoint accepts that token along with a new password and completes the password reset.
\nThe token is a signed JWT with a configurable expiry (default: 120 minutes).
\nConfigure the expiry with the property: password_reset_token_expiry_minutes
Required fields:
\n- token: The JWT reset token from the password reset email
\n- new_password: The new password (must meet strong password requirements)
The token is single-use. Once the password is reset, the token is invalidated.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\nnew_password: new_password
\n\nJSON response body fields:
\nmessage: 123456
\n","operationId":"OBPv6.0.0-resetPasswordComplete","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["new_password","token"],"properties":{"new_password":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"new_password":{"type":"string"},"token":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message"],"properties":{"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/comments/{commentid}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Comment","description":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCommentForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"commentid","in":"path","description":"The COMMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{account}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (ACCOUNT)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"account","in":"path","description":"The ACCOUNT identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","description","value"],"properties":{"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/InsurancePolicy/{insurancepolicyid}":{"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy by id","description":"Get InsurancePolicy by id.
\nWhich insurance policies the customer already has.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePolicy"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy_gh.29.uk","parameters":[{"name":"insurancepolicyid","in":"path","description":"The INSURANCEPOLICYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_policy"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_policy":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_policy_id","name","number"],"properties":{"insurance_policy_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePolicy","description":"Update InsurancePolicy.
\nWhich insurance policies the customer already has.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePolicy"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePolicy_gh.29.uk","parameters":[{"name":"insurancepolicyid","in":"path","description":"The INSURANCEPOLICYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_policy"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_policy":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_policy_id","name","number"],"properties":{"insurance_policy_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePolicy by id","description":"Delete InsurancePolicy by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePolicy"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePolicy_gh.29.uk","parameters":[{"name":"insurancepolicyid","in":"path","description":"The INSURANCEPOLICYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_policy"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_policy":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_policy_id","name","number"],"properties":{"insurance_policy_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/system-views-ids":{"get":{"tags":["View-System"],"summary":"Get Ids of System Views","description":"Get Ids of System Views
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n","operationId":"OBPv5.0.0-getSystemViewsIds","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/FooBar":{"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar List","description":"Get FooBar List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FooBar"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new FooBar.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FooBar"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createFooBar_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar"],"properties":{"foo_bar":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar_id","name","number"],"properties":{"foo_bar_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/my/consents/{email}":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent (EMAIL)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"phone_number": "+49 170 1234567"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"phone_number": "+49 170 1234567"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"phone_number": "+49 170 1234567"
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv3.1.0-createConsentEmail","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"email","in":"path","description":"The EMAIL identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","entitlements","everything","valid_from","views","consumer_id","time_to_live"],"properties":{"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consent_id","status","jwt"],"properties":{"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/location-categories":{"put":{"tags":["ATM"],"summary":"Update ATM Location Categories","description":"Update ATM Location Categories.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nlocation_categories: location_categories
\n","operationId":"OBPv4.0.0-updateAtmLocationCategories","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["location_categories"],"properties":{"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"location_categories":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["atm_id","location_categories"],"properties":{"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"atm_id":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/system/integrity/account-access-unique-index-1-check":{"get":{"tags":["System-Integrity"],"summary":"Check Unique Index at Account Access","description":"Check unique index at account access table.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","operationId":"OBPv5.1.0-accountAccessUniqueIndexCheck","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID":{"get":{"tags":["Dynamic-Resource-Doc"],"summary":"Get Dynamic Resource Doc by Id","description":"Get a Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-getDynamicResourceDoc","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Dynamic-Resource-Doc"],"summary":"Update Dynamic Resource Doc","description":"Update a Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-updateDynamicResourceDoc","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Resource-Doc"],"summary":"Delete Dynamic Resource Doc","description":"Delete a Dynamic Resource Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteDynamicResourceDoc","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transaction-requests/{transactionrequestid}/attributes/{attributeid}":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attribute By Id","description":"Get Transaction Request Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getTransactionRequestAttributeById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}},{"name":"attributeid","in":"path","description":"The ATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","transaction_request_attribute_id","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Update Transaction Request Attribute","description":"Update Transaction Request Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-updateTransactionRequestAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}},{"name":"attributeid","in":"path","description":"The ATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attribute_type","name","value"],"properties":{"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","transaction_request_attribute_id","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/customer":{"delete":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Delete Customer Attribute Definition","description":"Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteCustomerAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/web-hooks/account/notifications/on-create-transaction":{"post":{"tags":["Webhook","Bank"],"summary":"Create system level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the system.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","operationId":"OBPv4.0.0-createSystemAccountNotificationWebhook","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["http_method","http_protocol","url"],"properties":{"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","http_method","webhook_id","http_protocol","trigger_name","url"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/{userid}/attributes":{"get":{"tags":["User","User-Attribute","Attribute"],"summary":"Get User Attributes","description":"Get User Attributes for the user specified by USER_ID.
\nReturns non-personal user attributes (IsPersonal=false) that can be used in ABAC rules.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-getUserAttributes","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_attributes"],"properties":{"user_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"user_attributes":{"type":"array","items":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["User","User-Attribute","Attribute"],"summary":"Create User Attribute","description":"Create a User Attribute for the user specified by USER_ID.
\nUser Attributes are non-personal attributes (IsPersonal=false) that can be used in ABAC rules.
\nThey require a role to set, similar to Customer Attributes, Account Attributes, etc.
For personal attributes that users manage themselves, see the /my/personal-data-fields endpoints.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or "DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-createUserAttribute","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-message-docs":{"get":{"tags":["Dynamic-Message-Doc"],"summary":"Get all Bank Level Dynamic Message Docs","description":"Get all Bank Level Dynamic Message Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-getAllBankLevelDynamicMessageDocs","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic-message-docs"],"properties":{"dynamic-message-docs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic-message-docs":{"type":"array","items":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Message-Doc"],"summary":"Create Bank Level Dynamic Message Doc","description":"Create a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-createBankLevelDynamicMessageDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/system/integrity/banks/{bankid}/orphaned-account-check":{"get":{"tags":["System-Integrity"],"summary":"Check for Orphaned Accounts","description":"Check for orphaned accounts at Bank Account model
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","operationId":"OBPv5.1.0-orphanedAccountCheck","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/cache/namespaces":{"get":{"tags":["Cache","System","API"],"summary":"Get Cache Namespaces","description":"Returns information about all cache namespaces in the system.
\nThis endpoint provides visibility into:
\n* Cache namespace prefixes and their purposes
\n* Number of keys in each namespace
\n* TTL configurations
\n* Example keys for each namespace
This is useful for:
\n* Monitoring cache usage
\n* Understanding cache structure
\n* Debugging cache-related issues
\n* Planning cache management operations
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexample_key: example_key
\nkey_count: key_count
\nnamespaces: namespaces
\nprefix: prefix
\nttl_seconds: ttl_seconds
\n","operationId":"OBPv6.0.0-getCacheNamespaces","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["key_count","description","category","prefix","example_key","ttl_seconds"],"properties":{"ttl_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"prefix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"namespaces":{"type":"array","items":{"type":"object","properties":{"key_count":{"type":"integer"},"description":{"type":"string"},"category":{"type":"string"},"prefix":{"type":"string"},"example_key":{"type":"string"},"ttl_seconds":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/banks/{bankid}/customer/{customerid}/messages":{"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","description":"Create a message for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_department: Open Bank
\nfrom_person: Tom
\nmessage: 123456
\nJSON response body fields:
\n\n","operationId":"OBPv1.4.0-addCustomerMessage","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message","from_department","from_person"],"properties":{"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_department":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_person":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"from_person":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/verify-credentials":{"post":{"tags":["User"],"summary":"Verify User Credentials","description":"Verify a user's credentials (username, password, provider) and return user information if valid.
\nThis endpoint validates the provided credentials without creating a token or session.
\nIt can be used to verify user credentials in external systems.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\npassword: password
\nprovider: ETHEREUM
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv6.0.0-verifyUserCredentials","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["username","password","provider"],"properties":{"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"password":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"provider":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/account-access-requests/{accountaccessrequestid}/rejection":{"post":{"tags":["Account-Access-Request"],"summary":"Reject Account Access Request","description":"Reject an Account Access Request (checker step in maker/checker workflow).
\nThe checker must be a different user than the maker (requestor). This enforces dual control / maker-checker separation.
\nOnly requests with status INITIATED can be rejected.
\nA comment is required when rejecting a request.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ACCESS_REQUEST_ID: ACCOUNT_ACCESS_REQUEST_ID
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncomment: comment
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-rejectAccountAccessRequest","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"accountaccessrequestid","in":"path","description":"The ACCOUNTACCESSREQUESTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["comment"],"properties":{"comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"comment":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","checker_user_id","created","status","account_access_request_id","is_system_view","business_justification","bank_id","view_id","target_user_id","checker_comment","updated","account_id"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"status":{"type":"string"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"},"checker_comment":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/entitlements":{"get":{"tags":["Role","Entitlement"],"summary":"Get all Entitlements","description":"Login is required.
\nPossible filter on the role field:
\neg: /entitlements?role=CanGetCustomersAtOneBank
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.1.0-getAllEntitlements","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name","username","entitlement_id","user_id"],"properties":{"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"},"username":{"type":"string"},"entitlement_id":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-resource-docs":{"get":{"tags":["Dynamic-Resource-Doc"],"summary":"Get all Dynamic Resource Docs","description":"Get all Dynamic Resource Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-getAllDynamicResourceDocs","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic-resource-docs"],"properties":{"dynamic-resource-docs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic-resource-docs":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Resource-Doc"],"summary":"Create Dynamic Resource Doc","description":"Create a Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-createDynamicResourceDoc","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/personal-dynamic-entities/available":{"get":{"tags":["Dynamic-Entity","Personal-Dynamic-Entity","API"],"summary":"Get Available Personal Dynamic Entities","description":"Get all Dynamic Entities that support personal data storage (hasPersonalEntity == true).
\nThis endpoint allows regular users (without admin roles) to discover which dynamic entities
\nthey can interact with for storing personal data via the /my/ENTITY_NAME endpoints.
Authentication: User must be logged in (no special roles required).
\nUse case: Portals and apps can show users what personal data types are available
\nwithout needing admin access to view all dynamic entity definitions.
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-getAvailablePersonalDynamicEntities","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access","_links"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_links":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["related"],"properties":{"related":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rel","href","method"],"properties":{"rel":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"href":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"type":{"type":"string"}}},"language":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"},"_links":{"type":"object","properties":{"related":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"method":{"type":"string"}}}}}}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transactions/{transactionid}/attributes":{"get":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Get Transaction Attributes","description":"Get Transaction Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getTransactionAttributes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attributes"],"properties":{"transaction_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/endpoint-mappings":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get all Endpoint Mappings","description":"Get all Endpoint Mappings.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-getAllEndpointMappings","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["endpoint-mappings"],"properties":{"endpoint-mappings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Endpoint-Mapping"],"summary":"Create Endpoint Mapping","description":"Create an Endpoint Mapping.
\nNote: at moment only support the dynamic endpoints
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-createEndpointMapping","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/signal/channels/{channelname}/info":{"get":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"Get Signal Channel Info","description":"Signal channels provide short-lived, Redis-backed messaging designed for AI agent discovery and coordination, but usable by any authenticated OBP consumer.
\nMessages are ephemeral and will expire after the configured TTL (default 1 hour).
This endpoint returns metadata about a signal channel including the current message count and remaining TTL in seconds.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCHANNEL_NAME: CHANNEL_NAME
\nJSON response body fields:
\nchannel_name: channel_name
\nmessage_count: message_count
\nttl_seconds: ttl_seconds
\n","operationId":"OBPv6.0.0-getSignalChannelInfo","parameters":[{"name":"channelname","in":"path","description":"The CHANNELNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["ttl_seconds","message_count","channel_name"],"properties":{"ttl_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"ttl_seconds":{"type":"integer"},"message_count":{"type":"integer"},"channel_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/bank":{"put":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Create or Update Bank Attribute Definition","description":"Create or Update Bank Attribute Definition
\nThe category field must be Bank
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateBankAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/counterparties/{counterpartyid}":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Counterparty-Metadata"],"summary":"Get Counterparty by Id (Explicit)","description":"This endpoint returns a single Counterparty on an Account View specified by its COUNTERPARTY_ID:
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getExplicitCounterpartyById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","metadata","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["private_alias","physical_location","url","public_alias","open_corporates_url","more_info","corporate_location","image_url"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty","Account"],"summary":"Delete Counterparty (Explicit)","description":"This endpoint deletes the Counterparty on the Account / View specified by the COUNTERPARTY_ID.
\nIt also deletes any related Counterparty Metadata.
The User calling this endpoint must have access to the View specified in the URL and that View must have the permission can_delete_counterparty.
For a general introduction to Counterparties in OBP see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteExplicitCounterparty","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/fast-firehose/accounts":{"get":{"tags":["Account","Account-Firehose","FirehoseData"],"summary":"Get Fast Firehose Accounts at Bank","description":"This endpoint allows bulk access to accounts.
\noptional pagination parameters for filter with accounts
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncode: 125
\ncurrency: EUR
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getFastFirehoseAccountsAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","bank_id","owners","label","balance","number","account_attributes","id","account_routings"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["code","type","value"],"properties":{"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","user_name","provider"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"user_name":{"type":"string"},"provider":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/{userid}/group-entitlements/{groupid}":{"delete":{"tags":["Group","User","Entitlement"],"summary":"Remove User from Group","description":"Remove a user from a group. This will delete all entitlements that were created by this group membership.
\nOnly removes entitlements with:
\n- group_id matching GROUP_ID
\n- process = "GROUP_MEMBERSHIP"
Requires either:
\n- CanRemoveUserFromGroupAtAllBanks (for any group)
\n- CanRemoveUserFromGroupAtOneBank (for groups at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nGROUP_ID: GROUP_ID
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-removeUserFromGroup","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"groupid","in":"path","description":"The GROUPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules/{abacruleid}":{"get":{"tags":["ABAC"],"summary":"Get ABAC Rule","description":"Get an ABAC rule by its ID.
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nABAC_RULE_ID: ABAC_RULE_ID
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nupdated_by_user_id: updated_by_user_id
\n","operationId":"OBPv6.0.0-getAbacRule","parameters":[{"name":"abacruleid","in":"path","description":"The ABACRULEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","abac_rule_id","is_active","updated_by_user_id","created_by_user_id","description","rule_code","rule_name"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_by_user_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"policy":{"type":"string"},"abac_rule_id":{"type":"string"},"is_active":{"type":"boolean"},"updated_by_user_id":{"type":"string","format":"date-time"},"created_by_user_id":{"type":"string"},"description":{"type":"string"},"rule_code":{"type":"string"},"rule_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["ABAC"],"summary":"Update ABAC Rule","description":"Update an existing ABAC rule.
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nABAC_RULE_ID: ABAC_RULE_ID
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nupdated_by_user_id: updated_by_user_id
\n","operationId":"OBPv6.0.0-updateAbacRule","parameters":[{"name":"abacruleid","in":"path","description":"The ABACRULEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rule_name","is_active","description","rule_code","policy"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"rule_name":{"type":"string"},"is_active":{"type":"boolean"},"description":{"type":"string"},"rule_code":{"type":"string"},"policy":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rule_name","abac_rule_id","updated_by_user_id","is_active","description","created_by_user_id","rule_code","policy"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_by_user_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"rule_name":{"type":"string"},"abac_rule_id":{"type":"string"},"updated_by_user_id":{"type":"string","format":"date-time"},"is_active":{"type":"boolean"},"description":{"type":"string"},"created_by_user_id":{"type":"string"},"rule_code":{"type":"string"},"policy":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["ABAC"],"summary":"Delete ABAC Rule","description":"Delete an ABAC rule by its ID.
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nABAC_RULE_ID: ABAC_RULE_ID
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteAbacRule","parameters":[{"name":"abacruleid","in":"path","description":"The ABACRULEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/agents/{agentid}":{"get":{"tags":["Account"],"summary":"Get Agent","description":"Get Agent.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","operationId":"OBPv5.1.0-getAgent","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"agentid","in":"path","description":"The AGENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_id","is_pending_agent","currency","bank_id","legal_name","agent_number","mobile_phone_number","is_confirmed_agent"],"properties":{"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_confirmed_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_pending_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Customer","Person"],"summary":"Update Agent status","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","operationId":"OBPv5.1.0-updateAgentStatus","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"agentid","in":"path","description":"The AGENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_pending_agent","is_confirmed_agent"],"properties":{"is_pending_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_confirmed_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"is_pending_agent":{"type":"boolean"},"is_confirmed_agent":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_id","is_pending_agent","currency","bank_id","legal_name","agent_number","mobile_phone_number","is_confirmed_agent"],"properties":{"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_confirmed_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_pending_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-endpoints/{dynamicendpointid}/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Bank Level Dynamic Endpoint Host","description":"Update Bank Level dynamic endpoint Host.
\nThe value can be obp_mock, dynamic_entity, or some service url.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-updateBankLevelDynamicEndpointHost","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"host":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"host":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/other_account":{"get":{"tags":["Transaction","Counterparty"],"summary":"Get Other Account of Transaction","description":"Get other account of a transaction.
\nReturns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","operationId":"OBPv1.2.1-getOtherAccountForTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metadata","IBAN","swift_bic","number","holder","id","bank","kind"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"IBAN":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["national_identifier","name"],"properties":{"national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.0.0/consumer/consent-requests/{consentrequestid}/consents":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consent By Consent Request Id via Consumer","description":"This endpoint gets the Consent By consent request id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","operationId":"OBPv5.0.0-getConsentByConsentRequestId","parameters":[{"name":"consentrequestid","in":"path","description":"The CONSENTREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access","consent_request_id","consent_id","status","jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/transaction":{"get":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Get Transaction Attribute Definition","description":"Get Transaction Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getTransactionAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Create or Update Transaction Attribute Definition","description":"Create or Update Transaction Attribute Definition
\nThe category field must be Transaction
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateTransactionAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/connector/traces":{"get":{"tags":["Metric","API"],"summary":"Get Connector Traces","description":"Get connector traces which capture the full outbound/inbound messages for each connector call.
\nConnector tracing must be enabled via the write_connector_trace=true property.
\nFilters Part 1.filtering parameters to GET /management/connector/traces
\nShould be able to filter on the following fields:
\neg: /management/connector/traces?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 1000) eg:limit=2000
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 connector_name (if null ignore)
\n6 function_name (if null ignore)
\n7 correlation_id (if null ignore)
\n8 bank_id (if null ignore)
\n9 user_id (if null ignore)
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nconnector_trace_id: connector_trace_id
\nconnector_traces: connector_traces
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nduration: 5.123
\n\nhttp_verb: http_verb
\ninbound_message: inbound_message
\nis_successful: is_successful
\noutbound_message: outbound_message
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv6.0.0-getConnectorTraces","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_traces"],"properties":{"connector_traces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_trace_id","url","correlation_id","inbound_message","is_successful","user_id","bank_id","date","connector_name","function_name","outbound_message","duration","http_verb"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"correlation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"connector_trace_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"http_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_successful":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"connector_traces":{"type":"array","items":{"type":"object","properties":{"connector_trace_id":{"type":"integer"},"url":{"type":"string"},"correlation_id":{"type":"string"},"inbound_message":{"type":"string"},"is_successful":{"type":"boolean"},"user_id":{"type":"string"},"bank_id":{"type":"string"},"date":{"type":"string","format":"date-time"},"connector_name":{"type":"string"},"function_name":{"type":"string"},"outbound_message":{"type":"string"},"duration":{"type":"integer"},"http_verb":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/database/pool":{"get":{"tags":["System","API"],"summary":"Get Database Pool Information","description":"Returns HikariCP connection pool information including:
\nThis helps diagnose connection pool issues such as connection leaks or pool exhaustion.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nactive_connections: active_connections
\nconnection_timeout_ms: connection_timeout_ms
\nidle_connections: idle_connections
\nidle_timeout_ms: idle_timeout_ms
\nkeepalive_time_ms: keepalive_time_ms
\nmax_lifetime_ms: max_lifetime_ms
\nmaximum_pool_size: maximum_pool_size
\nminimum_idle: minimum_idle
\npool_name: pool_name
\nthreads_awaiting_connection: threads_awaiting_connection
\ntotal_connections: total_connections
\n","operationId":"OBPv6.0.0-getDatabasePoolInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["total_connections","connection_timeout_ms","idle_connections","active_connections","minimum_idle","threads_awaiting_connection","pool_name","maximum_pool_size","max_lifetime_ms","idle_timeout_ms","keepalive_time_ms"],"properties":{"max_lifetime_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"idle_timeout_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"keepalive_time_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_idle":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_connections":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"idle_connections":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pool_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"threads_awaiting_connection":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maximum_pool_size":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"total_connections":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"connection_timeout_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"total_connections":{"type":"integer"},"connection_timeout_ms":{"type":"integer"},"idle_connections":{"type":"integer"},"active_connections":{"type":"integer"},"minimum_idle":{"type":"integer"},"threads_awaiting_connection":{"type":"integer"},"pool_name":{"type":"string"},"maximum_pool_size":{"type":"integer"},"max_lifetime_ms":{"type":"integer"},"idle_timeout_ms":{"type":"integer"},"keepalive_time_ms":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/user/reset-password-url":{"post":{"tags":["User"],"summary":"Create Password Reset URL and Send Email","description":"Create a password reset URL for a user and automatically send it via email.
\nAuthentication is Required.
\nBehavior:
\n- Generates a unique password reset token
\n- Creates a reset URL using the portal_external_url property (falls back to API hostname)
\n- Sends an email to the user with the reset link
\n- Returns the reset URL in the response for logging/tracking purposes
Required fields:
\n- username: The user's username (typically email)
\n- email: The user's email address (must match username)
\n- user_id: The user's UUID
The user must exist and be validated before a reset URL can be generated.
\nEmail configuration must be set up correctly for email delivery to work.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nJSON response body fields:
\n\n","operationId":"OBPv6.0.0-resetPasswordUrl","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","username","user_id"],"properties":{"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_password_url"],"properties":{"reset_password_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"reset_password_url":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/consents":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get My Consents","description":"This endpoint gets the Consents created by a current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\n\n","operationId":"OBPv5.1.0-getMyConsents","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consents"],"properties":{"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","api_standard","consumer_id","last_usage_date","consent_id","last_action_date","consent_reference_id","jwt_payload","status","jwt","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt_payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["aud","views","nbf","exp","iss","iat","access","createdByUserId","email","jti","name","request_headers","entitlements","sub"],"properties":{"nbf":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_headers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["values","name"],"properties":{"values":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"jti":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"exp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"createdByUserId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"iat":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sub":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"aud":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iss":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["availableAccounts","transactions","accounts","balances"],"properties":{"availableAccounts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"consent_reference_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"status":{"type":"string"},"jwt":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/{userid}/group-entitlements":{"get":{"tags":["Group","User","Entitlement"],"summary":"Get User's Group Memberships","description":"Get all groups a user is a member of.
\nReturns groups where the user has entitlements with process = "GROUP_MEMBERSHIP".
\nThe response includes:
\n- list_of_entitlements: entitlements the user currently has from this group membership
Requires either:
\n- CanGetUserGroupMembershipsAtAllBanks (for any user)
\n- CanGetUserGroupMembershipsAtOneBank (for users at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ngroup_entitlements: group_entitlements
\ngroup_id: group_id
\ngroup_name: group_name
\nlist_of_entitlements: list_of_entitlements
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-getUserGroupMemberships","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_entitlements"],"properties":{"group_entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_id","list_of_entitlements","bank_id","user_id"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"group_entitlements":{"type":"array","items":{"type":"object","properties":{"group_name":{"type":"string"},"group_id":{"type":"string"},"list_of_entitlements":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Group","User","Entitlement"],"summary":"Grant User Membership to Group Entitlements","description":"Grant the User Group Entitlements.
\nThis endpoint creates entitlements for every Role in the Group. If the user
\nalready has a particular role at the same bank, that entitlement is skipped (not duplicated).
Each entitlement created will have:
\n- group_id set to the group ID
\n- process set to "GROUP_MEMBERSHIP"
Response Fields:
\n- target_entitlements: All roles defined in the group (the complete list of entitlements that this group aims to grant)
\n- entitlements_created: Roles that were newly created as entitlements during this operation
\n- entitlements_skipped: Roles that the user already possessed, so no new entitlement was created
Note: target_entitlements = entitlements_created + entitlements_skipped
\nRequires either:
\n- CanAddUserToGroupAtAllBanks (for any group)
\n- CanAddUserToGroupAtOneBank (for groups at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\ngroup_id: group_id
\nJSON response body fields:
\nentitlements_created: entitlements_created
\nentitlements_skipped: entitlements_skipped
\ngroup_id: group_id
\ngroup_name: group_name
\ntarget_entitlements: target_entitlements
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-addUserToGroup","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_id","entitlements_created","bank_id","entitlements_skipped","target_entitlements","user_id"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements_skipped":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements_created":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"group_name":{"type":"string"},"group_id":{"type":"string"},"entitlements_created":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"entitlements_skipped":{"type":"array","items":{"type":"string"}},"target_entitlements":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/accounts":{"post":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Post Accounts","description":"POST Accounts
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEndpointProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"url_pattern",\n "value":"http://obp_mock//accounts"\n },\n {\n "key":"http_method",\n "value":"POST"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEndpoint_POST_accounts","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"balance":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/user-account-access":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired","DAuth"],"summary":"Create (DAuth) User with Account Access","description":"This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.
\nPut the smart contract address in username
\nFor provider use "dauth"
\nThis endpoint will create the (DAuth) User with username and provider if the User does not already exist.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the logged in user needs to be account holder.
\nFor information about DAuth see below:
\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n) your-RSA-key-pair
\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://apisandbox.openbankproject.com/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nis_system: true
\nprovider: ETHEREUM
\nusername: felixsmith
\nview_id: owner
\n\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv5.1.0-createUserWithAccountAccessById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views","provider","username"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_system","view_id"],"properties":{"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"is_system":{"type":"boolean"},"view_id":{"type":"string"}}}},"provider":{"type":"string"},"username":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["head","tl"],"properties":{"head":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tl":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}},"example":{"type":"object","properties":{"head":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"tl":{"type":"object","properties":{}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/balances":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID","description":"Get the Balances for the Account specified by BANK_ID and ACCOUNT_ID through the VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","operationId":"OBPv5.1.0-getBankAccountBalances","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","balances","account_routings","account_id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","amount","currency"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/customers/{customerid}/kyc_statuses":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC statuses","description":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n\n","operationId":"OBPv2.0.0-getKycStatuses","parameters":[{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["statuses"],"properties":{"statuses":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","customer_number","date","ok"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"ok":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"statuses":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Dynamic Endpoints","description":"Get Dynamic Endpoints.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-getDynamicEndpoints","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Dynamic Endpoint","description":"Create dynamic endpoints.
\nCreate dynamic endpoints with one json format swagger content.
\nIf the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
\nplease check Endpoint Mapping endpoints.
If the host of swagger is obp_mock, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-createDynamicEndpoint","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/product-tree/{productcode}":{"get":{"tags":["Product"],"summary":"Get Product Tree","description":"Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE
\nand it's parent product(s) recursively as specified by parent_product_code.
Each product includes the following information.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","operationId":"OBPv3.1.0-getProductTree","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["super_family","description","details","code","more_info_url","meta","family","bank_id","parent_product","name","category"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_product":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["super_family","description","details","parent_product","code","more_info_url","meta","family","bank_id","name","category"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_product":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["super_family","description","details","code","more_info_url","meta","family","bank_id","name","category"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"super_family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"details":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"super_family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"details":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"super_family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"details":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"name":{"type":"string"},"category":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v3.1.0/management/banks/{bankid}/cards/{cardid}/attributes/{cardattributeid}":{"put":{"tags":["Card","Card-Attribute","Attribute"],"summary":"Update Card Attribute","description":"Update Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ATTRIBUTE_ID: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","operationId":"OBPv3.1.0-updateCardAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"cardid","in":"path","description":"The CARDID identifier","required":true,"schema":{"type":"string"}},{"name":"cardattributeid","in":"path","description":"The CARDATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","bank_id","card_id","attribute_type","name","card_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type","enum"],"properties":{"type":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}}}},"card_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"card_id":{"type":"string"},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]},"name":{"type":"string"},"card_attribute_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/supported-currencies":{"put":{"tags":["ATM"],"summary":"Update ATM Supported Currencies","description":"Update ATM Supported Currencies.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nsupported_currencies: ["EUR","MXN","USD"]
\n","operationId":"OBPv4.0.0-updateAtmSupportedCurrencies","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["supported_currencies"],"properties":{"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"supported_currencies":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["supported_currencies","atm_id"],"properties":{"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"supported_currencies":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/tags/{tagid}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","description":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account,
\nor must be the user that posted the tag.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"tagid","in":"path","description":"The TAGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/counterparties/{counterpartyid}/limit-status":{"get":{"tags":["Counterparty-Limits"],"summary":"Get Counterparty Limit Status","description":"Get Counterparty Limit Status.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\ncurrency_status: currency_status
\nmax_monthly_amount: 10000.11
\nmax_monthly_amount_status: max_monthly_amount_status
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_monthly_transactions_status: max_number_of_monthly_transactions_status
\nmax_number_of_transactions: 100
\nmax_number_of_transactions_status: max_number_of_transactions_status
\nmax_number_of_yearly_transactions: 100
\nmax_number_of_yearly_transactions_status: max_number_of_yearly_transactions_status
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_total_amount_status: max_total_amount_status
\nmax_yearly_amount: 12000.11
\nmax_yearly_amount_status: max_yearly_amount_status
\n\nview_id: owner
\n","operationId":"OBPv5.1.0-getCounterpartyLimitStatus","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","bank_id","counterparty_id","counterparty_limit_id","view_id","status","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","account_id","max_yearly_amount","max_number_of_transactions"],"properties":{"counterparty_limit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_number_of_yearly_transactions_status","max_number_of_monthly_transactions_status","max_yearly_amount_status","max_number_of_transactions_status","currency_status","max_total_amount_status","max_monthly_amount_status"],"properties":{"max_total_amount_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_monthly_amount_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"status":{"type":"object","properties":{"max_number_of_yearly_transactions_status":{"type":"integer"},"max_number_of_monthly_transactions_status":{"type":"integer"},"max_yearly_amount_status":{"type":"string"},"max_number_of_transactions_status":{"type":"integer"},"currency_status":{"type":"string"},"max_total_amount_status":{"type":"string"},"max_monthly_amount_status":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transactions/{transactionid}/attributes/{accountattributeid}":{"put":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Update Transaction Attribute","description":"Update Transaction Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-updateTransactionAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"accountattributeid","in":"path","description":"The ACCOUNTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/users/current/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers for Current User","description":"Gets all Customers that are linked to a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv3.0.0-getCustomersForUser","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","customer_attributes","last_ok_date","face_image","credit_limit","employment_status","email","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","date_of_birth","legal_name","title","dob_of_dependants","branch_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"last_ok_date":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test-dynamic-resource-doc/my_user/{myuserid}":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"A test endpoint","description":"A test endpoint.
\nJust for debug method body of dynamic resource doc.
\nbetter watch the following introduction video first
\n* Dynamic resourceDoc version1
The endpoint return the response from PractiseEndpoint code.
\nHere, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
\nYou 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.
\nURL Parameters:
\nMY_USER_ID: MY_USER_ID
\nJSON request body fields:
\nage: 18
\nhobby: hobby
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\nage: 18
\nhobby: hobby
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-test-dynamic-resource-doc","parameters":[{"name":"myuserid","in":"path","description":"The MYUSERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","age"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"object","properties":{}},"age":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","age"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"object","properties":{}},"age":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v2.0.0/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at all Banks","description":"Get public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","operationId":"OBPv2.0.0-publicAccountsAllBanks","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["label","id","bank_id","views_available"],"properties":{"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","id","is_public"],"properties":{"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v5.0.0/banks/{bankid}/accounts/{accountid}/views":{"get":{"tags":["View-Custom","Account"],"summary":"Get Views for Account","description":"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.
\nViews 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.
\nData: 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.
\nAction: 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.
\nMetadata:
\nTransaction 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).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nUser 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n\n","operationId":"OBPv5.0.0-getViewsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_revoke_access_to_views","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_grant_access_to_views","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustrans":{"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans List","description":"Get sustrans List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"sustrans"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /sustrans?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new sustrans.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"sustrans"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createsustrans_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans"],"properties":{"sustrans":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sustrans_id","name","number"],"properties":{"sustrans_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/funds-available":{"get":{"tags":["Account","Confirmation of Funds Service (PIIS)","PSD2"],"summary":"Check Available Funds","description":"Check Available Funds
\nMandatory URL parameters:
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ndate: 2020-01-27
\n","operationId":"OBPv3.1.0-checkFundsAvailable","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["available_funds_request_id","date","answer"],"properties":{"available_funds_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"answer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"available_funds_request_id":{"type":"string"},"date":{"type":"string","format":"date-time"},"answer":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/ui/suggested-session-timeout":{"get":{"tags":["API"],"summary":"Get Suggested Session Timeout","description":"Returns information about:
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\ntimeout_in_seconds: timeout_in_seconds
\n","operationId":"OBPv5.1.0-suggestedSessionTimeout","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["timeout_in_seconds"],"properties":{"timeout_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"timeout_in_seconds":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/management/cascading/banks/{bankid}/accounts/{accountid}":{"delete":{"tags":["Account"],"summary":"Delete Account Cascade","description":"Delete an Account Cascade specified by ACCOUNT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteAccountCascade","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/customers/customer-number":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer by CUSTOMER_NUMBER","description":"Gets the Customer specified by CUSTOMER_NUMBER.
\nDate Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv6.0.0-getCustomerByCustomerNumber","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","date_of_birth","customer_attributes","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"last_ok_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/target-views":{"post":{"tags":["View-Custom","Account"],"summary":"Create Custom View","description":"Create a custom view on bank account
\nUser 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.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe '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.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv5.1.0-createCustomView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_permissions","hide_metadata_if_alias_used","description","is_public","metadata_view","which_alias_to_use","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_permissions","hide_metadata_if_alias_used","description","is_public","metadata_view","name","alias","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/credit-limit":{"put":{"tags":["Customer"],"summary":"Update the credit limit of a Customer","description":"Update the credit limit of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerCreditLimit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["credit_limit"],"properties":{"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/system-views/{viewid}":{"get":{"tags":["View-System","View-Custom"],"summary":"Get System View","description":"Get a single system view by its ID.
\nSystem views are predefined views that apply to all accounts, such as:
\n- owner
\n- accountant
\n- auditor
\n- standard
The view is returned with an allowed_actions array containing all permissions for that view.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_revoke_access_to_views: can_revoke_access_to_views
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\nis_system: true
\n\n\nview_id: owner
\n\n","operationId":"OBPv6.0.0-getSystemViewById","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","is_firehose","hide_metadata_if_alias_used","is_system","description","is_public","metadata_view","can_revoke_access_to_views","view_id","alias","can_grant_access_to_views","allowed_actions"],"properties":{"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_firehose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"short_name":{"type":"string"},"is_firehose":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"is_system":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"view_id":{"type":"string"},"alias":{"type":"string"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"allowed_actions":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/entitlements/{entitlementid}":{"delete":{"tags":["Role","User","Entitlement"],"summary":"Delete Entitlement","description":"Delete Entitlement specified by ENTITLEMENT_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nRequires the CanDeleteEntitlementAtAnyBank role.
\nThis endpoint is idempotent - if the entitlement does not exist, it returns 204 No Content.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteEntitlement","parameters":[{"name":"entitlementid","in":"path","description":"The ENTITLEMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/owner/transaction-request-types/{ethsendrawtransaction}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"CREATE TRANSACTION REQUEST (ETH_SEND_RAW_TRANSACTION )","description":"Send ETH via Ethereum JSON-RPC.
\nAccountId should hold the 0x address for now.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nETH_SEND_RAW_TRANSACTION: ETH_SEND_RAW_TRANSACTION
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nparams: params
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv6.0.0-createTransactionRequestEthSendRawTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"ethsendrawtransaction","in":"path","description":"The ETHSENDRAWTRANSACTION identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","params"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"params":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"params":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/accounts/account-routing-regex-query":{"post":{"tags":["Account"],"summary":"Get Accounts by Account Routing Regex","description":"This endpoint returns an array of accounts matching the provided routing scheme and the routing address regex.
\nThe bank_id field is optional.
Example of account routing scheme: IBAN, OBP, AccountNumber, ...
\nExample of account routing address regex: DE175.*, 55897106215-[A-Z]{3}, ...
This endpoint can be used to retrieve multiples accounts matching a same account routing address pattern.
\nFor example, if you want to link multiple accounts having different currencies, you can create an account
\nwith 123456789-EUR as Account Number and an other account with 123456789-USD as Account Number.
\nSo we can identify the Account Number as 123456789, so to get all the accounts with the same account number
\nand the different currencies, we can use this body in the request :
{\n "bank_id": "BANK_ID",\n "account_routing": {\n "scheme": "AccountNumber",\n "address": "123456789-[A-Z]{3}"\n }\n}\nThis request will returns the accounts matching the routing address regex (123456789-EUR and 123456789-USD).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\n\nscheme: OBP
\nbank_id: gh.29.uk
\nJSON response body fields:
\n\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-getAccountsByAccountRoutingRegex","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_routing"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","tags","label","number","bank_id","owners","id","views_available","balance","account_attributes"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/resource-docs/{apiversion}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis 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.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor 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.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif 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.
\nYou 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.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://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.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv1.4.0-getResourceDocsObpV400","parameters":[{"name":"apiversion","in":"path","description":"The APIVERSION identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/customers/{customerid}/customer-account-links":{"get":{"tags":["Customer"],"summary":"Get Customer Account Links by CUSTOMER_ID","description":"Get Customer Account Links by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nlinks: links
\nrelationship_type: Owner
\n","operationId":"OBPv5.0.0-getCustomerAccountLinksByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["links"],"properties":{"links":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_account_link_id","customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_account_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/product":{"delete":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Delete Product Attribute Definition","description":"Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteProductAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/system-dynamic-entities/cascade/{dynamicentityid}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete System Level Dynamic Entity Cascade","description":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID and all its data records.
\nThis endpoint performs a cascade delete:
\n1. Automatically backs up the entity definition and all data records to a ZZ_BAK_ prefixed entity (e.g. my_entity is backed up to ZZ_BAK_my_entity). If a previous ZZ_BAK_ backup exists, it is overwritten.
\n2. Deletes all data records associated with the dynamic entity
\n3. Deletes the dynamic entity definition itself
Note: Entities whose name already starts with ZZ_BAK_ are not backed up again (to avoid infinite backup chains).
\nThis operation is only allowed for non-personal entities (hasPersonalEntity=false).
\nFor personal entities (hasPersonalEntity=true), you must delete the records and definition separately.
For more information see here/
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-deleteSystemDynamicEntityCascade","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/root":{"get":{"tags":["API"],"summary":"Get API Info (root)","description":"Returns information about:
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nconnector: connector
\n\n\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\n\n\nhostname: hostname
\nlocal_identity_provider: local_identity_provider
\n\n\n\nresource_docs_requires_role: resource_docs_requires_role
\n\n\n","operationId":"OBPv6.0.0-root","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hosted_at","local_identity_provider","git_commit","hosted_by","connector","hostname","resource_docs_requires_role","version","energy_source","version_status"],"properties":{"local_identity_provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"resource_docs_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hostname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hosted_at":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["organisation_website","organisation"],"properties":{"organisation_website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"organisation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"connector":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"energy_source":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["organisation","organisation_website"],"properties":{"organisation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"organisation_website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"hosted_by":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["organisation","phone","email","organisation_website"],"properties":{"organisation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"organisation_website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"git_commit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"hosted_at":{"type":"object","properties":{"organisation_website":{"type":"string"},"organisation":{"type":"string"}}},"local_identity_provider":{"type":"string"},"git_commit":{"type":"string"},"hosted_by":{"type":"object","properties":{"organisation":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"organisation_website":{"type":"string"}}},"connector":{"type":"string"},"hostname":{"type":"string"},"resource_docs_requires_role":{"type":"boolean"},"version":{"type":"string"},"energy_source":{"type":"object","properties":{"organisation":{"type":"string"},"organisation_website":{"type":"string"}}},"version_status":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v2.0.0/users/{userid}/entitlements":{"post":{"tags":["Role","Entitlement","User"],"summary":"Add Entitlement for a User","description":"Create Entitlement. Grant Role to User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","operationId":"OBPv2.0.0-addEntitlement","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/retail-customers/{customerid}":{"get":{"tags":["Retail-Customer","Customer"],"summary":"Get Retail Customer by CUSTOMER_ID","description":"Gets the Retail Customer specified by CUSTOMER_ID.
\nReturns 404 if the customer exists but is not of type INDIVIDUAL.
\nUse the generic /customers/CUSTOMER_ID endpoint for any customer type.
Date Format:
\ndate_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv6.0.0-getRetailCustomerByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","date_of_birth","customer_attributes","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"last_ok_date":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/customer_cars":{"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars List","description":"Get customer_cars List.
\nThe car the customer arrived in
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"customer_cars"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new customer_cars.
\nThe car the customer arrived in
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"customer_cars"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createcustomer_cars_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_identifier","manufacturer"],"properties":{"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars"],"properties":{"customer_cars":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars_id","customer_identifier","manufacturer"],"properties":{"customer_cars_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/endpoints/{operationid}/tags":{"get":{"tags":["API"],"summary":"Get Bank Level Endpoint Tags","description":"Get Bank Level Endpoint Tags.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-getBankLevelEndpointTags","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["head","tl"],"properties":{"head":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tl":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}},"example":{"type":"object","properties":{"head":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"tl":{"type":"object","properties":{}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["API"],"summary":"Create Bank Level Endpoint Tag","description":"Create Bank Level Endpoint Tag
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON request body fields:
\ntag_name: BankAccountTag1
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-createBankLevelEndpointTag","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tag_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers/{consumerid}/consumer/rate-limits":{"get":{"tags":["Consumer"],"summary":"Get Rate Limits for a Consumer","description":"Get Calls limits per Consumer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncreated_at: created_at
\nfrom_date: 1100-01-01T01:01:01.000Z
\nlimits: limits
\n\n\n\n\n\n\nrate_limiting_id: rate_limiting_id
\nto_date: 1100-01-01T01:01:01.000Z
\nupdated_at: updated_at
\n","operationId":"OBPv5.1.0-getCallsLimit","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["limits"],"properties":{"limits":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","updated_at","rate_limiting_id","created_at","per_second_call_limit","per_week_call_limit","per_day_call_limit","per_minute_call_limit","per_month_call_limit","per_hour_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"rate_limiting_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"updated_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"limits":{"type":"array","items":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"rate_limiting_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"per_second_call_limit":{"type":"string"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/transaction":{"get":{"tags":["Transaction"],"summary":"Get Transaction by Id","description":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","operationId":"OBPv3.1.0-getTransactionByIdForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metadata","details","transaction_attributes","this_account","id","other_account"],"properties":{"this_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","bank_routing","holders","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"holders":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","description","posted","new_balance","completed","value"],"properties":{"new_balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative","tags","comments","images","where"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"images":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","id","date","user","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"comments":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"other_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","metadata","bank_routing","holder","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"transaction_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"id":{"type":"string"},"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/consumers/{consumerid}/consumer/call-limits":{"get":{"tags":["Consumer"],"summary":"Get Rate Limits for a Consumer","description":"Get Rate Limits per Consumer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\n\n\n\n\n\ncalls_made: 50
\n\nper_day: 4000
\n\n\nper_month: 500
\nper_second: 1000
\nper_week: 50000
\n\n","operationId":"OBPv3.1.0-getCallsLimit","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["current_state","per_week_call_limit","per_day_call_limit","per_second_call_limit","per_month_call_limit","per_hour_call_limit","per_minute_call_limit"],"properties":{"current_state":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["per_week","per_day","per_minute","per_month","per_second","per_hour"],"properties":{"per_week":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_second":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_month":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_day":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_minute":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_hour":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reset_in_seconds","calls_made"],"properties":{"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"current_state":{"type":"object","properties":{"per_week":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_day":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_minute":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_month":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_second":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_hour":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}}}},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/consumers/current":{"get":{"tags":["Consumer","API"],"summary":"Get Current Consumer","description":"Returns the consumer_id of the current authenticated consumer.
\nThis endpoint requires authentication via:
\n* User authentication (OAuth, DirectLogin, etc.) - returns the consumer associated with the user's session
\n* Consumer/Client authentication - returns the consumer credentials being used
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nactive_at_date: active_at_date
\nactive_per_day_rate_limit: active_per_day_rate_limit
\nactive_per_hour_rate_limit: active_per_hour_rate_limit
\nactive_per_minute_rate_limit: active_per_minute_rate_limit
\nactive_per_month_rate_limit: active_per_month_rate_limit
\nactive_per_second_rate_limit: active_per_second_rate_limit
\nactive_per_week_rate_limit: active_per_week_rate_limit
\nactive_rate_limits: active_rate_limits
\napp_name: appNameBank
\napp_type: Web
\ncall_counters: call_counters
\nconsidered_rate_limit_ids: considered_rate_limit_ids
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nper_day: 4000
\n\n\nper_month: 500
\nper_second: 1000
\nper_week: 50000
\n\ncalls_made: 50
\n\n","operationId":"OBPv6.0.0-getCurrentConsumer","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name","description","consumer_id","call_counters","app_type","active_rate_limits"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_rate_limits":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["active_per_minute_rate_limit","active_per_hour_rate_limit","active_per_day_rate_limit","active_per_second_rate_limit","considered_rate_limit_ids","active_at_date","active_per_week_rate_limit","active_per_month_rate_limit"],"properties":{"active_at_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"active_per_second_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_day_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_week_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"considered_rate_limit_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"active_per_minute_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_month_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_hour_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"call_counters":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["per_month","per_hour","per_week","per_second","per_minute","per_day"],"properties":{"per_week":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_second":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_month":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_day":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_minute":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_hour":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"app_name":{"type":"string"},"description":{"type":"string"},"consumer_id":{"type":"string"},"call_counters":{"type":"object","properties":{"per_month":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_hour":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_week":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_second":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_minute":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_day":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}}}},"app_type":{"type":"string"},"active_rate_limits":{"type":"object","properties":{"active_per_minute_rate_limit":{"type":"integer"},"active_per_hour_rate_limit":{"type":"integer"},"active_per_day_rate_limit":{"type":"integer"},"active_per_second_rate_limit":{"type":"integer"},"considered_rate_limit_ids":{"type":"array","items":{"type":"string"}},"active_at_date":{"type":"string","format":"date-time"},"active_per_week_rate_limit":{"type":"integer"},"active_per_month_rate_limit":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/branches":{"get":{"tags":["Branch","Bank"],"summary":"Get Branches for a Bank","description":"Returns information about branches for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 50 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nYou can also use the follow url query parameters:
city - string, find Branches those in this city, optional
\nwithinMetersOf - number, find Branches within given meters distance, optional
\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","operationId":"OBPv3.0.0-getBranches","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["branches"],"properties":{"branches":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibleFeatures","more_info","branch_type","name","bank_id","location","id","is_accessible","address","drive_up","branch_routing","meta","phone_number","lobby"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"drive_up":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["friday","monday","saturday","thursday","tuesday","wednesday","sunday"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"lobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["saturday","tuesday","monday","friday","sunday","wednesday","thursday"],"properties":{"sunday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tuesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"wednesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"monday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"friday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"thursday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"saturday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"accessibleFeatures":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","county","postcode","line_1","line_2","line_3","state","country_code"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"branches":{"type":"array","items":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Branch"],"summary":"Create Branch","description":"Create Branch for the Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","operationId":"OBPv3.0.0-createBranch","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibleFeatures","more_info","branch_type","name","bank_id","location","id","is_accessible","address","drive_up","branch_routing","meta","phone_number","lobby"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"drive_up":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["friday","monday","saturday","thursday","tuesday","wednesday","sunday"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"lobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["saturday","tuesday","monday","friday","sunday","wednesday","thursday"],"properties":{"sunday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tuesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"wednesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"monday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"friday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"thursday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"saturday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"accessibleFeatures":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","county","postcode","line_1","line_2","line_3","state","country_code"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibleFeatures","more_info","branch_type","name","bank_id","location","id","is_accessible","address","drive_up","branch_routing","meta","phone_number","lobby"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"drive_up":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["friday","monday","saturday","thursday","tuesday","wednesday","sunday"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"lobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["saturday","tuesday","monday","friday","sunday","wednesday","thursday"],"properties":{"sunday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tuesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"wednesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"monday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"friday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"thursday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"saturday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"accessibleFeatures":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","county","postcode","line_1","line_2","line_3","state","country_code"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/authentication-type-validations/{operationid}":{"get":{"tags":["Authentication-Type-Validation"],"summary":"Get an Authentication Type Validation","description":"Get an Authentication Type Validation by operation_id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getAuthenticationTypeValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authTypes","operationId"],"properties":{"authTypes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Authentication-Type-Validation"],"summary":"Update an Authentication Type Validation","description":"Update an Authentication Type Validation.
\nPlease supply allowed authentication types.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-updateAuthenticationTypeValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["head","tl"],"properties":{"head":{"type":"object","required":["type","enum"],"properties":{"type":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}}}},"tl":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}}}},"example":{"type":"object","properties":{"head":{"type":"string","enum":["DirectLogin","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI","Anonymous"]},"tl":{"type":"array","items":{"type":"object","properties":{}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authTypes","operationId"],"properties":{"authTypes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Authentication-Type-Validation"],"summary":"Create an Authentication Type Validation","description":"Create an Authentication Type Validation.
\nPlease supply allowed authentication types.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON request body fields:
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-createAuthenticationTypeValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["head","tl"],"properties":{"head":{"type":"object","required":["type","enum"],"properties":{"type":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}}}},"tl":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}}}},"example":{"type":"object","properties":{"head":{"type":"string","enum":["DirectLogin","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI","Anonymous"]},"tl":{"type":"array","items":{"type":"object","properties":{}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["authTypes","operationId"],"properties":{"authTypes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Authentication-Type-Validation"],"summary":"Delete an Authentication Type Validation","description":"Delete an Authentication Type Validation by operation_id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteAuthenticationTypeValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/identity":{"put":{"tags":["Customer"],"summary":"Update the identity data of a Customer","description":"Update the identity data of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerIdentity","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name_suffix","legal_name","title","date_of_birth"],"properties":{"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/customer-account-links":{"post":{"tags":["Customer","Account"],"summary":"Create Customer Account Link","description":"Link a Customer to a Account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","operationId":"OBPv5.0.0-createCustomerAccountLink","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_account_link_id","customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_account_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get My Dynamic Entities","description":"Get all Dynamic Entity definitions I created.
\nThis v6.0.0 endpoint returns a cleaner response format with:
\n* snake_case field names (dynamic_entity_id, user_id, bank_id, has_personal_entity)
\n* An explicit entity_name field instead of using the entity name as a dynamic JSON key
\n* The entity schema in a separate definition object
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-getMyDynamicEntities","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access","_links"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_links":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["related"],"properties":{"related":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rel","href","method"],"properties":{"rel":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"href":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"type":{"type":"string"}}},"language":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"},"_links":{"type":"object","properties":{"related":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"method":{"type":"string"}}}}}}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/tax-residence":{"post":{"tags":["Customer","KYC"],"summary":"Create Tax Residence","description":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\n\ntax_number: 456
\nJSON response body fields:
\n\ntax_number: 456
\n\n","operationId":"OBPv3.1.0-createTaxResidence","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tax_number","domain"],"properties":{"tax_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"domain":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tax_number","domain","tax_residence_id"],"properties":{"tax_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"domain":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tax_residence_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/private":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Accounts at Bank (Minimal)","description":"Returns the minimal list of private accounts at BANK_ID that the user has access to.
\nFor each account, the API returns the ID, routing addresses and the views available to the current user.
If you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\naccount_type: AC
\n\n\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nscheme: OBP
\n\n\n","operationId":"OBPv3.0.0-privateAccountsAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","account_type","bank_id","id","views","label"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","is_public","short_name","id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"id":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"is_public":{"type":"boolean"},"short_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/api-products/{apiproductcode}/attribute":{"post":{"tags":["API","Api-Product-Attribute"],"summary":"Create Api Product Attribute","description":"Create an Api Product Attribute.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv6.0.0-createApiProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","is_active","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-policies/{policy}/execute":{"post":{"tags":["ABAC"],"summary":"Execute ABAC Policy","description":"Execute all ABAC rules in a policy to test access control.
\nThis endpoint executes all active rules that belong to the specified policy.
\nThe policy uses OR logic - access is granted if at least one rule passes.
This allows you to test a complete policy with specific context (authenticated user, bank, account, transaction, customer, etc.).
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
\n- here - Testing examples and patterns
You can provide optional IDs in the request body to test the policy with specific context.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPOLICY: POLICY
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nauthenticated_user_id: authenticated_user_id
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\non_behalf_of_user_id: on_behalf_of_user_id
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n","operationId":"OBPv6.0.0-executeAbacPolicy","parameters":[{"name":"policy","in":"path","description":"The POLICY identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","bank_id","authenticated_user_id","transaction_id","view_id","on_behalf_of_user_id","user_id","account_id","transaction_request_id"],"properties":{"transaction_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_behalf_of_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"authenticated_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"},"authenticated_user_id":{"type":"string"},"transaction_id":{"type":"string"},"view_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"},"user_id":{"type":"string"},"account_id":{"type":"string"},"transaction_request_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["result"],"properties":{"result":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"result":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/banks/{bankid}/dynamic-entities/{dynamicentityid}":{"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update Bank Level Dynamic Entity","description":"Update a bank level Dynamic Entity.
\nThis v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.
Request format:
\n{\n "entity_name": "customer_preferences",\n "has_personal_entity": true,\n "has_public_access": false,\n "has_community_access": false,\n "personal_requires_role": false,\n "schema": {\n "description": "User preferences updated",\n "required": ["theme"],\n "properties": {\n "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference"},\n "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"},\n "notifications_enabled": {"type": "boolean", "example": "true", "description": "Whether to send notifications"}\n }\n }\n}\nNote:
\n* The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
\n* Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
\n* Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
\n* Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
\n* Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-updateBankLevelDynamicEntity","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","has_personal_entity","entity_name","has_public_access"],"properties":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"has_personal_entity":{"type":"boolean"},"entity_name":{"type":"string"},"has_public_access":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","bank_id","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"bank_id":{"type":"string"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/email-validation":{"post":{"tags":["User"],"summary":"Validate User Email","description":"Validate a user's email address using the JWT token sent via email.
\nThis endpoint is called anonymously (no authentication required).
\nWhen a user signs up and email validation is enabled (authUser.skipEmailValidation=false),
\nthey receive an email with a validation link containing a signed JWT token.
This endpoint:
\n- Verifies the JWT signature and checks expiry
\n- Extracts the unique ID from the JWT subject
\n- Sets the user's validated status to true
\n- Resets the unique ID token (invalidating the link)
\n- Grants default entitlements to the user
Important: This is a single-use token. Once the email is validated, the token is invalidated.
\nAny subsequent attempts to use the same token will return a 404 error (UserNotFoundByToken or UserAlreadyValidated).
The token is a signed JWT with a configurable expiry (default: 1440 minutes / 24 hours).
\nThe server-side expiry can be configured with the email_validation_token_expiry_minutes property.
User Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\nJSON response body fields:
\n\nmessage: 123456
\nprovider: ETHEREUM
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nvalidated: validated
\n","operationId":"OBPv6.0.0-validateUserEmail","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["token"],"properties":{"token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"token":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","message","username","validated","user_id","provider"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"validated":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"message":{"type":"string"},"username":{"type":"string"},"validated":{"type":"boolean"},"user_id":{"type":"string"},"provider":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/banks/{bankid}/accounts/{accountid}/views":{"post":{"tags":["View-Custom","Account"],"summary":"Create Custom View (Management)","description":"Create a custom view on a bank account via management endpoint.
\nThis is a management endpoint that requires the CanCreateCustomView role (entitlement).
This endpoint provides a simpler, role-based authorization model compared to the original
\nv3.0.0 endpoint which requires view-level permissions. Use this endpoint when you want to
\ngrant view creation ability through direct role assignment rather than through view access.
For the original endpoint that checks account-level view permissions, see:
\nPOST /obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe 'alias' field in the JSON can take one of three values:
\n''(empty string): to use no alias; the view shows the real name of the other account.
\nThe '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.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv6.0.0-createCustomViewManagement","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hide_metadata_if_alias_used","name","description","is_public","metadata_view","which_alias_to_use","allowed_actions"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/standing-order":{"post":{"tags":["Standing-Order","Account"],"summary":"Create Standing Order","description":"Create standing order for an account.
\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\n","operationId":"OBPv4.0.0-createStandingOrder","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","counterparty_id","when","date_signed","amount","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["frequency","detail"],"properties":{"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"counterparty_id":{"type":"string"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"date_signed":{"type":"string","format":"date-time"},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","active","date_signed","bank_id","standing_order_id","date_cancelled","counterparty_id","when","amount","account_id","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"standing_order_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_cancelled":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["frequency","detail"],"properties":{"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"date_signed":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"standing_order_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/search/warehouse/{index}":{"post":{"tags":["Data-Warehouse"],"summary":"Data Warehouse Search","description":"Search the data warehouse and get row level results.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanSearchWarehouse entitlement is required. You can request the Role below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
\nPOST /search/warehouse/INDEX1,INDEX2
\nPOST /search/warehouse/ALL
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\nnone:
\n","operationId":"OBPv3.0.0-dataWarehouseSearch","parameters":[{"name":"index","in":"path","description":"The INDEX identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["query"],"properties":{"query":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["match_all"],"properties":{"match_all":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}}}}}},"example":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"example":{"type":"object","properties":{}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{userid}/banks/{bankid}/accounts-held":{"get":{"tags":["Account"],"summary":"Get Accounts Held By User","description":"Get Accounts held by the User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/users/USER_ID/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","operationId":"OBPv5.1.0-getAccountsHeldByUserAtBank","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","number","id","label","bank_id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/resource-docs/{apiversion}/swagger":{"get":{"tags":["Documentation","API"],"summary":"Get Swagger documentation","description":"Returns documentation about the RESTful resources on this server in Swagger format.
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
\n(All endpoints are given one or more tags which for used in grouping)
\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
\n(Each endpoint is implemented in the OBP Scala code by a 'function')
\nSee the Resource Doc endpoint for more information.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nFollowing are more examples:
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
\nhttps://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.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv1.4.0-getResourceDocsSwagger","parameters":[{"name":"apiversion","in":"path","description":"The APIVERSION identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/card":{"delete":{"tags":["Card","Card-Attribute","Attribute"],"summary":"Delete Card Attribute Definition","description":"Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteCardAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/transaction":{"delete":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Delete Transaction Attribute Definition","description":"Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteTransactionAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{provider}/{username}/lock-status":{"get":{"tags":["User"],"summary":"Get User Lock Status","description":"Get User Login Status.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\nbad_attempts_since_last_success_or_reset:
\nlast_failure_date: 2020-01-27
\nusername: felixsmith
\n","operationId":"OBPv5.1.0-getUserLockStatus","parameters":[{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"username","in":"path","description":"The USERNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["last_failure_date","bad_attempts_since_last_success_or_reset","username"],"properties":{"last_failure_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"bad_attempts_since_last_success_or_reset":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"last_failure_date":{"type":"string","format":"date-time"},"bad_attempts_since_last_success_or_reset":{"type":"integer"},"username":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["User"],"summary":"Unlock the user","description":"Unlock a User.
\n(Perhaps the user was locked due to multiple failed login attempts)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\nbad_attempts_since_last_success_or_reset:
\nlast_failure_date: 2020-01-27
\nusername: felixsmith
\n","operationId":"OBPv5.1.0-unlockUserByProviderAndUsername","parameters":[{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"username","in":"path","description":"The USERNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["last_failure_date","bad_attempts_since_last_success_or_reset","username"],"properties":{"last_failure_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"bad_attempts_since_last_success_or_reset":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"last_failure_date":{"type":"string","format":"date-time"},"bad_attempts_since_last_success_or_reset":{"type":"integer"},"username":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get all Entitlement Requests","description":"Get all Entitlement Requests
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.0.0-getAllEntitlementRequests","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_requests"],"properties":{"entitlement_requests":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_request_id","role_name","bank_id","user","created"],"properties":{"entitlement_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"created":{"type":"string","format":"date-time"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Role","Entitlement","User"],"summary":"Create Entitlement Request for current User","description":"Create Entitlement Request.
\nAny logged in User can use this endpoint to request an Entitlement
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.0.0-addEntitlementRequest","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_request_id","role_name","bank_id","user","created"],"properties":{"entitlement_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"created":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/method_routings":{"get":{"tags":["Method-Routing","API"],"summary":"Get MethodRoutings","description":"Get the all MethodRoutings.
\nQuery url parameters:
\neg:
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?active=true
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","operationId":"OBPv3.1.0-getMethodRoutings","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["method_routings"],"properties":{"method_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["parameters","is_bank_id_exact_match","method_name","connector_name","bank_id_pattern","method_routing_id"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id_pattern":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_bank_id_exact_match":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"method_routing_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"method_routings":{"type":"array","items":{"type":"object","properties":{"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"connector_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Method-Routing","API"],"summary":"Create MethodRouting","description":"Create a MethodRouting.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExplanation of Fields:
\nnote and CAVEAT!:
\nIf the connector name starts with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n![\"Snipaste_outBoundMapping\"](\"https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png\")
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n![\"inBoundMapping\"](\"https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png\")
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
JSON request body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","operationId":"OBPv3.1.0-createMethodRouting","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["method_name","bank_id_pattern","parameters","is_bank_id_exact_match","connector_name"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id_pattern":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_bank_id_exact_match":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"connector_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["method_name","bank_id_pattern","parameters","is_bank_id_exact_match","method_routing_id","connector_name"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id_pattern":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_bank_id_exact_match":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"method_routing_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/product":{"get":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Get Product Attribute Definition","description":"Get Product Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getProductAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Create or Update Product Attribute Definition","description":"Create or Update Product Attribute Definition
\nThe category field must be Product
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateProductAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/api-products":{"get":{"tags":["API","Api-Product"],"summary":"Get Api Products","description":"Get Api Products for the Bank.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\napi_product_id: api_product_id
\napi_products: api_products
\nbank_id: gh.29.uk
\n\ncollection_id: collection_id
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nmonthly_subscription_amount: monthly_subscription_amount
\nmonthly_subscription_currency: monthly_subscription_currency
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_api_product_code: parent_api_product_code
\n\n\n\n\n\n\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nis_active: false
\n","operationId":"OBPv6.0.0-getApiProducts","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_products"],"properties":{"api_products":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","monthly_subscription_amount","monthly_subscription_currency","category","per_day_call_limit","per_minute_call_limit","description","attributes","per_week_call_limit","per_second_call_limit","parent_api_product_code","per_month_call_limit","bank_id","collection_id","terms_and_conditions_url","more_info_url","api_product_id","api_product_code","per_hour_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_products":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"category":{"type":"string"},"per_day_call_limit":{"type":"integer"},"per_minute_call_limit":{"type":"integer"},"description":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}},"per_week_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_month_call_limit":{"type":"integer"},"bank_id":{"type":"string"},"collection_id":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"more_info_url":{"type":"string"},"api_product_id":{"type":"string"},"api_product_code":{"type":"string"},"per_hour_call_limit":{"type":"integer"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/management/system-dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get System Dynamic Entities","description":"Get all System Dynamic Entities with record counts.
\nEach dynamic entity in the response includes a record_count field showing how many data records exist for that entity.
This v6.0.0 endpoint returns snake_case field names and an explicit entity_name field.
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-getSystemDynamicEntities","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","record_count","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"record_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"type":{"type":"string"}}},"language":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"record_count":{"type":"integer"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Create System Level Dynamic Entity","description":"Create a system level Dynamic Entity.
\nThis v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.
Request format:
\n{\n "entity_name": "customer_preferences",\n "has_personal_entity": true,\n "has_public_access": false,\n "has_community_access": false,\n "personal_requires_role": false,\n "schema": {\n "description": "User preferences",\n "required": ["theme"],\n "properties": {\n "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference"},\n "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"}\n }\n }\n}\nNote:
\n* The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
\n* Each property MUST include an example field with a valid example value.
\n* Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
\n* Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
\n* Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
\n* Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-createSystemDynamicEntity","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["has_community_access","schema","has_personal_entity","personal_requires_role","entity_name","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"has_community_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}}}}}},"has_personal_entity":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_public_access":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entity_id","has_community_access","schema","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}}}}}},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/banks/{bankid}/accounts/{accountid}":{"put":{"tags":["Account"],"summary":"Update Account","description":"Update the account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","operationId":"OBPv3.1.0-updateAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","branch_id","label","type"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","branch_id","label","type","bank_id","account_id"],"properties":{"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules/validate":{"post":{"tags":["ABAC"],"summary":"Validate ABAC Rule","description":"Validate ABAC rule code syntax and structure without creating or executing the rule.
\nThis endpoint performs the following validations:
\n- Parse the rule_code as a Scala expression
\n- Validate syntax - check for parsing errors
\n- Validate field references - check if referenced objects/fields exist
\n- Check type consistency - verify the expression returns a Boolean
Available ABAC Context Objects:
\n- AuthenticatedUser - The user who is logged in
\n- OnBehalfOfUser - Optional delegation user
\n- User - Target user being evaluated
\n- Bank, Account, View, Transaction, TransactionRequest, Customer
\n- Attributes for each entity (e.g., userAttributes, accountAttributes)
Documentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
This is a "dry-run" validation that does NOT save or execute the rule.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nrule_code: rule_code
\nJSON response body fields:
\nmessage: 123456
\nvalid: valid
\n","operationId":"OBPv6.0.0-validateAbacRule","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rule_code"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"rule_code":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message","valid"],"properties":{"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message":{"type":"string"},"valid":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collections/{apicollectionid}":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collection By Id","description":"Get Api Collection By API_COLLECTION_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getMyApiCollectionById","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Api-Collection"],"summary":"Delete My Api Collection","description":"Delete Api Collection By API_COLLECTION_ID
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteMyApiCollection","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/system/integrity/banks/{bankid}/account-currency-check":{"get":{"tags":["System-Integrity"],"summary":"Check for Sensible Currencies","description":"Check for sensible currencies at Bank Account model
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","operationId":"OBPv5.1.0-accountCurrencyCheck","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts":{"get":{"tags":["Counterparty","Account"],"summary":"Get Other Accounts of one Account","description":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
\nUser Authentication is Optional. The User need not be logged in.
Authentication is required if the view VIEW_ID is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\n\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nprovider: ETHEREUM
\n\nscheme: OBP
\nuser:
\n","operationId":"OBPv3.0.0-getOtherAccountsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["other_accounts"],"properties":{"other_accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","metadata","bank_routing","holder","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"other_accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/account":{"delete":{"tags":["Account","Account-Attribute","Attribute"],"summary":"Delete Account Attribute Definition","description":"Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteAccountAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transactions":{"get":{"tags":["Transaction","Account"],"summary":"Get Transactions for Account (Full)","description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nNote: This v6.0.0 endpoint returns bank_id directly in both this_account and other_account objects,
\nmaking it easier to identify which bank each account belongs to without parsing the bank_routing object.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbank_id: gh.29.uk
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\n\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","operationId":"OBPv6.0.0-getTransactionsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metadata","details","transaction_id","other_account","transaction_attributes","this_account"],"properties":{"this_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","bank_routing","bank_id","holders","account_id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"holders":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","is_alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","description","completed","new_balance","posted","value"],"properties":{"new_balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative","tags","comments","images","where"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"images":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","id","date","user","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"comments":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"other_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","metadata","bank_routing","bank_id","account_routings","holder"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"transaction_attributes":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}}}}}}}},"example":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_id":{"type":"string"},"other_account":{"type":"object","properties":{"account_id":{"type":"string"},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"bank_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}}},"transaction_attributes":{"type":"object","properties":{}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"bank_id":{"type":"string"},"holders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_alias":{"type":"boolean"}}}},"account_id":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user-invitations":{"get":{"tags":["User-Invitation"],"summary":"Get User Invitations","description":"Get User Invitations
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","operationId":"OBPv4.0.0-getUserInvitations","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","purpose","first_name","country","status","company","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["User-Invitation","KYC"],"summary":"Get User Invitation Information","description":"Get User Invitation Information.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nsecret_key: secret_key
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","operationId":"OBPv4.0.0-getUserInvitationAnonymous","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["secret_key"],"properties":{"secret_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"secret_key":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","purpose","first_name","country","status","company","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v3.1.0/banks/{bankid}/products/{productcode}/attributes/{productattributeid}":{"delete":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Delete Product Attribute","description":"Delete Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nDelete a Product Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productattributeid","in":"path","description":"The PRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/email":{"put":{"tags":["Customer"],"summary":"Update the email of a Customer","description":"Update an email of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerEmail","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email"],"properties":{"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/system/integrity/custom-view-names-check":{"get":{"tags":["System-Integrity"],"summary":"Check Custom View Names","description":"Check custom view names.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","operationId":"OBPv5.1.0-customViewNamesCheck","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/accounts/{accountid}/{viewid}/counterparties":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Account"],"summary":"Get Counterparties for any account (Explicit)","description":"This is a management endpoint that gets the Counterparties that have been explicitly created for an Account / View.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\n\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getCounterpartiesForAnyAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparties"],"properties":{"counterparties":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"counterparties":{"type":"array","items":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty","Account"],"summary":"Create Counterparty for any account (Explicit)","description":"This is a management endpoint that allows the creation of a Counterparty on any Account.
\nFor an introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nvalue: 5987953
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createCounterpartyForAnyAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","other_account_routing_address","name","other_bank_routing_scheme","currency","other_account_secondary_routing_address","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","metadata","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["private_alias","physical_location","url","public_alias","open_corporates_url","more_info","corporate_location","image_url"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{userid}/accounts-held":{"get":{"tags":["Account"],"summary":"Get Accounts Held By User","description":"Get Accounts held by the User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/users/USER_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","operationId":"OBPv5.1.0-getAccountsHeldByUser","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","number","id","label","bank_id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-message-docs":{"get":{"tags":["Dynamic-Message-Doc"],"summary":"Get all Dynamic Message Docs","description":"Get all Dynamic Message Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-getAllDynamicMessageDocs","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic-message-docs"],"properties":{"dynamic-message-docs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic-message-docs":{"type":"array","items":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Message-Doc"],"summary":"Create Dynamic Message Doc","description":"Create a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-createDynamicMessageDoc","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{sepa}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SEPA)","description":"Special instructions for SEPA:
\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSEPA:
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncode: 125
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\niban: DE91 1000 0000 0123 4567 89
\nto:
\nvalue: 5987953
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nfuture_date: 20200127
\n\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestSepa","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"sepa","in":"path","description":"The SEPA identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["future_date","reasons","to","description","value","charge_policy"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"reasons":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","code","amount","document_number","currency"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"document_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"future_date":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"code":{"type":"string"},"amount":{"type":"string"},"document_number":{"type":"string"},"currency":{"type":"string"}}}},"to":{"type":"object","properties":{"iban":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/obp.testing.01/ObpActivity":{"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity List","description":"Get ObpActivity List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"ObpActivity"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new ObpActivity.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"ObpActivity"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createObpActivity_obp.testing.01","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","username","created_date"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","obp_activity"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"obp_activity":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["obp_activity_id","name","username","created_date"],"properties":{"obp_activity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"created_date":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/endpoint-mappings/{endpointmappingid}":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get Bank Level Endpoint Mapping","description":"Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-getBankLevelEndpointMapping","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Endpoint-Mapping"],"summary":"Update Bank Level Endpoint Mapping","description":"Update an Bank Level Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-updateBankLevelEndpointMapping","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Endpoint-Mapping"],"summary":"Delete Bank Level Endpoint Mapping","description":"Delete a Bank Level Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankLevelEndpointMapping","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test1":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 List","description":"Get test1 List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /test1?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new test1.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createtest1_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1"],"properties":{"test1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test1_id","name","number"],"properties":{"test1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/search/customers/mobile-phone-number":{"post":{"tags":["Customer","KYC"],"summary":"Get Customers by MOBILE_PHONE_NUMBER","description":"Gets the Customers specified by MOBILE_PHONE_NUMBER.
\nThere are two wildcards often used in conjunction with the LIKE operator:
\n% - The percent sign represents zero, one, or multiple characters
\n_ - The underscore represents a single character
\nFor example {"customer_phone_number":"%381%"} lists all numbers which contain 381 sequence
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nmobile_phone_number: +49 30 901820
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv4.0.0-getCustomersByCustomerPhoneNumber","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/{accountid}/views/{viewid}":{"put":{"tags":["View-Custom","Account"],"summary":"Update Custom View","description":"Update an existing custom view on a bank account
\nUser 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.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv3.0.0-updateViewForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_actions","description","hide_metadata_if_alias_used","metadata_view","is_public","which_alias_to_use"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"allowed_actions":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"hide_metadata_if_alias_used":{"type":"boolean"},"metadata_view":{"type":"string"},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/api/versions":{"get":{"tags":["Documentation","API"],"summary":"Get Scanned API Versions","description":"Get all scanned API versions available in this codebase.
\nThis endpoint returns all API versions that have been discovered/scanned, along with their active status.
\nResponse Fields:
\nurl_prefix: The URL prefix for the version (e.g., "obp", "berlin-group", "open-banking")api_standard: The API standard name (e.g., "OBP", "BG", "UK", "STET")api_short_version: The version number (e.g., "v4.0.0", "v1.3")fully_qualified_version: The fully qualified version combining standard and version (e.g., "OBPv4.0.0", "BGv1.3")is_active: Boolean indicating if the version is currently enabled and accessibleActive Status:
\nis_active=true: Version is enabled and can be accessed via its URL prefixis_active=false: Version is scanned but disabled (via api_disabled_versions props)Use Cases:
\nNote: This differs from v4.0.0's /api/versions endpoint which shows all scanned versions without is_active status.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\napi_short_version: api_short_version
\napi_standard: api_standard
\nfully_qualified_version: fully_qualified_version
\nis_active: false
\nurl_prefix: url_prefix
\n","operationId":"OBPv6.0.0-getScannedApiVersions","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scanned_api_versions"],"properties":{"scanned_api_versions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_active","url_prefix","fully_qualified_version","api_standard","api_short_version"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url_prefix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_short_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"fully_qualified_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"scanned_api_versions":{"type":"array","items":{"type":"object","properties":{"is_active":{"type":"boolean"},"url_prefix":{"type":"string"},"fully_qualified_version":{"type":"string"},"api_standard":{"type":"string"},"api_short_version":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 List","description":"Get test_daniel707 List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new test_daniel707.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createtest_daniel707_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/account-web-hooks":{"put":{"tags":["Webhook","Bank"],"summary":"Enable/Disable an Account Webhook","description":"Enable/Disable an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","operationId":"OBPv3.1.0-enableDisableAccountWebhook","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_webhook_id","is_active"],"properties":{"account_webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_webhook_id":{"type":"string"},"is_active":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","http_method","is_active","bank_id","http_protocol","account_webhook_id","trigger_name","account_id","url"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Webhook","Bank"],"summary":"Create an Account Webhook","description":"Create an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","operationId":"OBPv3.1.0-createAccountWebhook","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["http_method","is_active","http_protocol","trigger_name","account_id","url"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"http_method":{"type":"string"},"is_active":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","http_method","is_active","bank_id","http_protocol","account_webhook_id","trigger_name","account_id","url"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/public/accounts/{accountid}/{viewid}/account":{"get":{"tags":["Account-Public","Account"],"summary":"Get Public Account by Id","description":"Returns information about an account that has a public view.
\nThe account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\ntype:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv3.0.0-getPublicAccountById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","type","account_rules","bank_id","owners","account_attributes","label","balance","number","id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_rules":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"type":{"type":"string"},"account_rules":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/my/correlated-entities":{"get":{"tags":["Customer"],"summary":"Get Correlated Entities for the current User","description":"Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncorrelated_entities: correlated_entities
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\ninsert_date: 2020-01-27
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nvalue: 5987953
\n\n\n","operationId":"OBPv4.0.0-getMyCorrelatedEntities","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["correlated_entities"],"properties":{"correlated_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["users","customer"],"properties":{"users":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","user_attributes","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"correlated_entities":{"type":"array","items":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"user_attributes":{"type":"array","items":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}}},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Metrics","description":"Get API metrics rows. These are records of each REST API call.
\nrequire CanReadMetrics role
\nNOTE: Automatic from_date Default
\nIf you do not provide a from_date parameter, this endpoint will automatically set it to:
\nnow - 9 minutes ago
This prevents accidentally querying all metrics since Unix Epoch and ensures reasonable response times.
\nFor historical/reporting queries, always explicitly specify your desired from_date.
IMPORTANT: Smart Caching & Performance
\nThis endpoint uses intelligent two-tier caching to optimize performance:
\nStable Data Cache (Long TTL):
\n- Metrics older than 600 seconds (10 minutes) are considered immutable/stable
\n- These are cached for 86400 seconds (24 hours)
\n- Used when your query's from_date is older than the stable boundary
Recent Data Cache (Short TTL):
\n- Recent metrics (within the stable boundary) are cached for 7 seconds
\n- Used when your query includes recent data or has no from_date
STRONGLY RECOMMENDED: Always specify from_date in your queries!
\nWhy from_date matters:
\n- Queries WITH from_date older than 10 mins → cached for 24 hours (fast!)
\n- Queries WITHOUT from_date → cached for only 7 seconds (slower)
Examples:
\n- from_date=2025-01-01T00:00:00.000Z → Uses 24 hours cache (historical data)
\n- from_date=1100-01-01T01:01:01.000Z (recent date) → Uses 7 seconds cache (recent data)
\n- No from_date → Automatically set to 9 minutes ago → Uses 7 seconds cache (recent data)
For best performance on historical/reporting queries, always include a from_date parameter!
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nYou can filter by the following fields by applying url parameters
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date e.g.:from_date=1100-01-01T01:01:01.000Z
\nDEFAULT: If not provided, automatically set to now - 9 minutes (keeps queries in recent data zone)
\nIMPORTANT: Including from_date enables long-term caching for historical data queries!
2 to_date e.g.:to_date=1100-01-01T01:01:01.000Z Defaults to a far future date i.e. Sat Jan 01 00:00:00 UTC 4000
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) - Returns calls where duration > specified value (in milliseconds). Use this to find slow API calls. eg: duration=5000 returns calls taking more than 5 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\noperation_id: OBPv6.0.0-getBanks
\nresponse_body: response_body
\nsource_ip: source_ip
\ntarget_ip: target_ip
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nverb:
\n","operationId":"OBPv6.0.0-getMetrics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name","implemented_in_version","developer_email","operation_id","consumer_id","target_ip","verb","response_body","implemented_by_partial_function","date","user_name","source_ip","url","duration","correlation_id","user_id"],"properties":{"duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["code","message"],"properties":{"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"implemented_in_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_ip":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"correlation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"implemented_by_partial_function":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source_ip":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"implemented_in_version":{"type":"string"},"developer_email":{"type":"string"},"operation_id":{"type":"string"},"consumer_id":{"type":"string"},"target_ip":{"type":"string"},"verb":{"type":"string"},"response_body":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}},"implemented_by_partial_function":{"type":"string"},"date":{"type":"string","format":"date-time"},"user_name":{"type":"string"},"source_ip":{"type":"string"},"url":{"type":"string"},"duration":{"type":"integer"},"correlation_id":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}/fees/{productfeeid}":{"get":{"tags":["Product"],"summary":"Get Product Fee","description":"Get Product Fee
\nGet one product fee by its id.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getProductFee","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productfeeid","in":"path","description":"The PRODUCTFEEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","is_active","bank_id","name","more_info","value","product_fee_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_fee_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Product"],"summary":"Update Product Fee","description":"Update Product Fee.
\nUpdate one Product Fee by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-updateProductFee","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productfeeid","in":"path","description":"The PRODUCTFEEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_active","name","more_info","value"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","is_active","bank_id","name","more_info","value","product_fee_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_fee_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Product"],"summary":"Delete Product Fee","description":"Delete Product Fee
\nDelete one product fee by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteProductFee","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productfeeid","in":"path","description":"The PRODUCTFEEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{freeform}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"summary":"Create Transaction Request (FREE_FORM)","description":"For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestFreeForm","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"freeform","in":"path","description":"The FREEFORM identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/endpoints/{operationid}/tags":{"get":{"tags":["API"],"summary":"Get System Level Endpoint Tags","description":"Get System Level Endpoint Tags.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-getSystemLevelEndpointTags","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["head","tl"],"properties":{"head":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tl":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}},"example":{"type":"object","properties":{"head":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"tl":{"type":"object","properties":{}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["API"],"summary":"Create System Level Endpoint Tag","description":"Create System Level Endpoint Tag
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON request body fields:
\ntag_name: BankAccountTag1
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-createSystemLevelEndpointTag","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tag_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/regulated-entities/{regulatedentityid}":{"get":{"tags":["Directory","API"],"summary":"Get Regulated Entity","description":"Get Regulated Entity By REGULATED_ENTITY_ID
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv5.1.0-getRegulatedEntityById","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity_country","entity_certificate_public_key","entity_code","services","entity_town_city","entity_name","entity_post_code","entity_web_site","entity_id","entity_type","certificate_authority_ca_owner_id","attributes","entity_address"],"properties":{"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["CY"],"properties":{"CY":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"entity_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_web_site":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_certificate_public_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributeType","name","value"],"properties":{"attributeType":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entity_post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_town_city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_authority_ca_owner_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Directory","API"],"summary":"Delete Regulated Entity","description":"Delete Regulated Entity specified by REGULATED_ENTITY_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteRegulatedEntity","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/entitlement-requests/{entitlementrequestid}":{"delete":{"tags":["Role","Entitlement","User"],"summary":"Delete Entitlement Request","description":"Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv3.0.0-deleteEntitlementRequest","parameters":[{"name":"entitlementrequestid","in":"path","description":"The ENTITLEMENTREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/FishPort/{fishportid}":{"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort by id","description":"Get FishPort by id.
\nPortfolio of fishbased values
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FishPort"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleFishPort_","parameters":[{"name":"fishportid","in":"path","description":"The FISHPORTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port"],"properties":{"fish_port":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port_id","fish","number"],"properties":{"fish_port_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Update FishPort","description":"Update FishPort.
\nPortfolio of fishbased values
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FishPort"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateFishPort_","parameters":[{"name":"fishportid","in":"path","description":"The FISHPORTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish","number"],"properties":{"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"fish":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port"],"properties":{"fish_port":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port_id","fish","number"],"properties":{"fish_port_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Delete FishPort by id","description":"Delete FishPort by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FishPort"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteFishPort_","parameters":[{"name":"fishportid","in":"path","description":"The FISHPORTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port"],"properties":{"fish_port":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["fish_port_id","fish","number"],"properties":{"fish_port_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"fish":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string"},"fish":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers/{consumerid}/consumer/certificate":{"put":{"tags":["Consumer"],"summary":"Update Consumer Certificate","description":"Update a Certificate for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-updateConsumerCertificate","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"certificate":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}/fee":{"post":{"tags":["Product"],"summary":"Create Product Fee","description":"Create Product Fee
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createProductFee","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_active","name","more_info","value"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","is_active","bank_id","name","more_info","value","product_fee_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_fee_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/images/{imageid}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Image","description":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteImageForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"imageid","in":"path","description":"The IMAGEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test_daniel707/TEST_DANIEL707_ID":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 by id","description":"Get test_daniel707 by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingletest_daniel707_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update test_daniel707","description":"Update test_daniel707.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updatetest_daniel707_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete test_daniel707 by id","description":"Delete test_daniel707 by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deletetest_daniel707_","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/transaction-requests/{transactionrequestid}":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request by ID","description":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv5.1.0-getTransactionRequestById","parameters":[{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenge","status","end_date","charge","transaction_ids","from","details","start_date","id"],"properties":{"challenge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","allowed_attempts","id"],"properties":{"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Transaction-Request"],"summary":"Update Transaction Request Status","description":"Update Transaction Request Status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\n\n","operationId":"OBPv5.1.0-updateTransactionRequestStatus","parameters":[{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system/log-cache/error":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Error Level Log Cache","description":"Returns ERROR level logs from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/error?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheErrorEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attributes":{"get":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Get Bank Attributes","description":"Get Bank Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_attributes: bank_attributes
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-getBankAttributes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_attributes"],"properties":{"bank_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","bank_id","type","name","is_active","bank_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"bank_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/settlement-accounts":{"get":{"tags":["Bank","PSD2"],"summary":"Get Settlement accounts at Bank","description":"Get settlement accounts on this API instance
\nReturns a list of settlement accounts at this Bank
Note: a settlement account is considered as a bank account.
\nSo you can update it and add account attributes to it using the regular account endpoints
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: OBP
\n\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-getSettlementAccounts","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["settlement_accounts"],"properties":{"settlement_accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","payment_system","label","balance","account_attributes","branch_id","account_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"payment_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"settlement_accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Bank"],"summary":"Create Settlement Account","description":"Create a new settlement account at a bank.
\nThe created settlement account id will be the concatenation of the payment system and the account currency.
\nFor examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD
By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID
\nThose two accounts have EUR as default currency.
If you want to create default settlement account for a specific currency, you can fill the payment_system field with the DEFAULT value.
When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.
\nIf no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.
\n- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
\n- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
\n- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the POST body USER_ID is not specified, the account will be owned by the logged in User.
\nNote: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\npayment_system: SEPA
\nscheme: OBP
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-createSettlementAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","payment_system","label","balance","branch_id","user_id"],"properties":{"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"payment_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","payment_system","label","balance","account_attributes","branch_id","account_id","user_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"payment_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/password-reset-url":{"post":{"tags":["User"],"summary":"Request Password Reset Email","description":"Request a password reset email for a user. No authentication is required.
\nAuthentication is NOT Required.
\nThis endpoint is designed for users who have forgotten their password and cannot log in.
\nBehavior:
\n- Looks up the user by username and email
\n- Generates a unique password reset token
\n- Creates a reset URL using the portal_external_url property (falls back to API hostname)
\n- Sends an email to the user with the reset link
Required fields:
\n- username: The user's username (typically email)
\n- email: The user's email address (must match username)
The user must exist and be validated before a reset email can be sent.
\nEmail configuration must be set up correctly for email delivery to work.
\nNote: For security reasons, this endpoint returns a generic success message regardless of
\nwhether the user was found, to prevent user enumeration.
User Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\nusername: felixsmith
\nJSON response body fields:
\nmessage: 123456
\n","operationId":"OBPv6.0.0-resetPasswordUrlAnonymous","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","username"],"properties":{"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"username":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message"],"properties":{"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/regulated-entities":{"get":{"tags":["Directory","API"],"summary":"Get Regulated Entities","description":"Returns information about:
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentities: entities
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv5.1.0-regulatedEntities","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entities"],"properties":{"entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity_country","entity_certificate_public_key","entity_code","services","entity_town_city","entity_name","entity_post_code","entity_web_site","entity_id","entity_type","certificate_authority_ca_owner_id","attributes","entity_address"],"properties":{"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["CY"],"properties":{"CY":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"entity_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_web_site":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_certificate_public_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributeType","name","value"],"properties":{"attributeType":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entity_post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_town_city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_authority_ca_owner_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Directory","API"],"summary":"Create Regulated Entity","description":"Create Regulated Entity
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv5.1.0-createRegulatedEntity","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity_country","entity_certificate_public_key","entity_code","services","entity_town_city","entity_name","entity_post_code","entity_web_site","entity_type","certificate_authority_ca_owner_id","attributes","entity_address"],"properties":{"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["CY"],"properties":{"CY":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"entity_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_web_site":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_certificate_public_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributeType","name","value"],"properties":{"attributeType":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entity_post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_town_city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_authority_ca_owner_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity_country","entity_certificate_public_key","entity_code","services","entity_town_city","entity_name","entity_post_code","entity_web_site","entity_id","entity_type","certificate_authority_ca_owner_id","attributes","entity_address"],"properties":{"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["CY"],"properties":{"CY":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"entity_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_web_site":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_certificate_public_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributeType","name","value"],"properties":{"attributeType":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entity_post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_town_city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_authority_ca_owner_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/{userid}/attributes/{userattributeid}":{"get":{"tags":["User","User-Attribute","Attribute"],"summary":"Get User Attribute By Id","description":"Get a User Attribute by USER_ATTRIBUTE_ID for the user specified by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-getUserAttributeById","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["User","User-Attribute","Attribute"],"summary":"Update User Attribute","description":"Update a User Attribute by USER_ATTRIBUTE_ID for the user specified by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-updateUserAttribute","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","value","name"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["User","User-Attribute","Attribute"],"summary":"Delete User Attribute","description":"Delete a User Attribute by USER_ATTRIBUTE_ID for the user specified by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteUserAttribute","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/jwks-uris":{"get":{"tags":["API","OAuth","OIDC"],"summary":"Get JSON Web Key (JWK) URIs","description":"Get the OAuth2 server's public JSON Web Key (JWK) URIs.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\n\n","operationId":"OBPv3.1.0-getOAuth2ServerJWKsURIs","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jwks_uris"],"properties":{"jwks_uris":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jwks_uri"],"properties":{"jwks_uri":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"jwks_uris":{"type":"array","items":{"type":"object","properties":{"jwks_uri":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/my/api-collection-ids/{apicollectionid}/api-collection-endpoint-ids/{apicollectionendpointid}":{"delete":{"tags":["Api-Collection"],"summary":"Delete My Api Collection Endpoint By Id","description":"glossary-item-not-found
\nDelete Api Collection Endpoint
\nDelete Api Collection Endpoint By Id
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteMyApiCollectionEndpointById","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"apicollectionendpointid","in":"path","description":"The APICOLLECTIONENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/system-views/{viewid}":{"get":{"tags":["View-System"],"summary":"Get System View","description":"Get System View
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv5.0.0-getSystemView","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_revoke_access_to_views","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_grant_access_to_views","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["View-System"],"summary":"Delete System View","description":"Deletes the system view specified by VIEW_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv5.0.0-deleteSystemView","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transactions/{transactionid}/attribute":{"post":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Create Transaction Attribute","description":"Create Transaction Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createTransactionAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/firehose/customers":{"get":{"tags":["Customer","FirehoseData"],"summary":"Get Firehose Customers","description":"Get Customers that has a firehose View.
\nAllows bulk access to customers.
\nUser must have the CanUseFirehoseAtAnyBank Role
Possible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-getFirehoseCustomers","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","customer_id","relationship_status","last_ok_date","bank_id","highest_education_attained","customer_number","credit_rating","legal_name","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/MarchHare":{"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare List","description":"Get MarchHare List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"MarchHare"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new MarchHare.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"MarchHare"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createMarchHare_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","march_hare"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"march_hare":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["march_hare_id","name","number"],"properties":{"march_hare_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/consent-infos":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get My Consents Info","description":"This endpoint gets the Consents that the current User created.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_standard: api_standard
\n\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\n\n","operationId":"OBPv4.0.0-getConsentInfos","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consents"],"properties":{"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","api_standard","consumer_id","last_usage_date","last_action_date","consent_id","status","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/users/current/consumers":{"get":{"tags":["Consumer"],"summary":"Get Consumers (logged in User)","description":"Get the Consumers for logged in User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.1.0-getConsumersForCurrentUser","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumers"],"properties":{"consumers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name","enabled","created_by_user","description","developer_email","created","consumer_id","redirect_url","app_type"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consumers":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/cache/config":{"get":{"tags":["Cache","System","API"],"summary":"Get Cache Configuration","description":"Returns cache configuration information including:
\nThis helps understand what cache backend is being used and how it's configured.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\navailable: available
\ncurrent_size: current_size
\nenvironment: environment
\nglobal_prefix: global_prefix
\nin_memory_status: in_memory_status
\ninstance_id: instance_id
\nport: port
\nredis_status: redis_status
\nurl: http://www.example.com/id-docs/123/image.png
\nuse_ssl: use_ssl
\n","operationId":"OBPv6.0.0-getCacheConfig","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["in_memory_status","redis_status","instance_id","environment","global_prefix"],"properties":{"global_prefix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redis_status":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["available","url","use_ssl","port"],"properties":{"available":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"use_ssl":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"port":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"environment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"in_memory_status":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["available","current_size"],"properties":{"available":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"current_size":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"instance_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"in_memory_status":{"type":"object","properties":{"available":{"type":"boolean"},"current_size":{"type":"integer"}}},"redis_status":{"type":"object","properties":{"available":{"type":"boolean"},"url":{"type":"string"},"use_ssl":{"type":"boolean"},"port":{"type":"integer"}}},"instance_id":{"type":"string"},"environment":{"type":"string"},"global_prefix":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/cascading/banks/{bankid}/customers/{customerid}":{"delete":{"tags":["Customer"],"summary":"Delete Customer Cascade","description":"Delete a Customer Cascade specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteCustomerCascade","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers":{"get":{"tags":["Consumer"],"summary":"Get Consumers","description":"Get the all Consumers.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-getConsumers","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumers"],"properties":{"consumers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consumers":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Consumer"],"summary":"Create a Consumer","description":"Create a Consumer (Authenticated access).
\nA Consumer represents an application that uses the Open Bank Project API. Each Consumer has:
\n- A unique key (40 character random string) - used as the client ID for authentication
\n- A unique secret (40 character random string) - used for secure authentication
\n- An app_type (Confidential or Public) - determines OAuth2 flow requirements
\n- Metadata like app_name, description, developer_email, company, etc.
How it works (for comprehension flow):
\nClient Certificate (Optional but Recommended for PSD2/Berlin Group):
\nThe client_certificate field provides enhanced security through X.509 certificate validation.
IMPORTANT SECURITY NOTE:
\n- This endpoint does NOT validate the certificate at creation time - any certificate can be provided
\n- The certificate is simply stored with the consumer record without checking if it's from a trusted CA
\n- For PSD2/Berlin Group compliance with certificate validation, use the Dynamic Registration endpoint instead
\n- Dynamic Registration validates certificates against registered Regulated Entities and trusted CAs
How certificates are used (after creation):
\n- Certificate is stored in PEM format (Base64-encoded X.509) with the consumer record
\n- On subsequent API requests, the certificate from the PSD2-CERT header is compared against the stored certificate
\n- If certificates don't match, access is denied even with valid OAuth2 tokens
\n- First request populates the certificate if not set; subsequent requests must match that certificate
Certificate validation process (during API requests, NOT at consumer creation):
\n1. Certificate from PSD2-CERT header is compared to stored certificate (simple string match)
\n2. Certificate is parsed from PEM format to X.509Certificate object
\n3. Validated against a configured trust store (PKCS12 format) containing trusted root CAs
\n4. Certificate chain is verified using PKIX validation
\n5. Optional CRL (Certificate Revocation List) checking if enabled via use_tpp_signature_revocation_list
\n6. Public key from certificate can verify signed requests (Berlin Group requirement)
Note: Steps 3-6 only apply during API request validation, NOT during consumer creation via this endpoint.
\nSecurity benefits (when properly configured):
\n- Certificate binding: Links consumer to a specific certificate (prevents token reuse with different certs)
\n- Request verification: Certificate's public key can verify signed requests
\n- Non-repudiation: Certificate-based signatures prove request origin
Security limitations of this endpoint:
\n- No validation at creation: Any certificate (even self-signed or expired) can be stored
\n- No CA verification: Certificate is not checked against trusted root CAs during creation
\n- No Regulated Entity check: Does not verify the TPP is registered
\n- Use Dynamic Registration instead for proper PSD2/Berlin Group compliance with full certificate validation
For proper PSD2 compliance:
\nUse the Dynamic Consumer Registration endpoint (POST /obp/v5.1.0/dynamic-registration/consumers) which:
\n- Requires JWT-signed request using the certificate's private key
\n- Validates certificate against Regulated Entity registry
\n- Checks certificate is from a trusted CA using the configured trust store
\n- Ensures proper QWAC/eIDAS compliance for EU TPPs
Configuration properties (for runtime validation):
\n- truststore.path.tpp_signature - Path to trust store for certificate validation during API requests
\n- truststore.password.tpp_signature - Trust store password
\n- use_tpp_signature_revocation_list - Enable/disable CRL checking during requests (default: true)
\n- consumer_validation_method_for_consent - Set to "CONSUMER_CERTIFICATE" for cert-based validation
\n- bypass_tpp_signature_validation - Emergency bypass (default: false, use only for testing)
Important: The key and secret are only shown once in the response. Save them securely as they cannot be retrieved later.
\nPlease note: Your consumer may be disabled as a result of this action.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napp_name: appNameBank
\napp_type: Web
\ncompany: Tesobe GmbH
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nenabled: false
\nredirect_url: https://apisandbox.openbankproject.com
\nclient_certificate: client_certificate
\nlogo_url: logo_url
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\nconsumer_secret: xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-createConsumer","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","logo_url","developer_email","client_certificate","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"client_certificate":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"client_certificate":{"type":"string"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","consumer_secret","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_secret":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"consumer_secret":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for One Bank","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getEntitlementsForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_id","bank_id","role_name","user_id"],"properties":{"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attributes/{bankattributeid}":{"get":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Get Bank Attribute By BANK_ATTRIBUTE_ID","description":"Get Bank Attribute By BANK_ATTRIBUTE_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-getBankAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"bankattributeid","in":"path","description":"The BANKATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","bank_id","type","name","is_active","bank_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Update Bank Attribute","description":"Update Bank Attribute.
\nUpdate one Bak Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-updateBankAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"bankattributeid","in":"path","description":"The BANKATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value","is_active","type"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","type","category","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Delete Bank Attribute","description":"Delete Bank Attribute
\nDelete a Bank Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"bankattributeid","in":"path","description":"The BANKATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/{attributedefinitionid}/transaction-request":{"delete":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Delete Transaction Request Attribute Definition","description":"Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteTransactionRequestAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"attributedefinitionid","in":"path","description":"The ATTRIBUTEDEFINITIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/customers/{customerid}/social_media_handles":{"get":{"tags":["Customer"],"summary":"Get Customer Social Media Handles","description":"Get social media handles for a customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncustomer_number: 5987953
\n\n\n\ntype:
\n","operationId":"OBPv2.0.0-getSocialMediaHandles","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["checks"],"properties":{"checks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_added","date_activated","type","customer_number","handle"],"properties":{"date_activated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_added":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"handle":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"date_activated":{"type":"string","format":"date-time"},"type":{"type":"string"},"customer_number":{"type":"string"},"handle":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Customer"],"summary":"Create Customer Social Media Handle","description":"Create a customer social media handle for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\ncustomer_number: 5987953
\n\n\n\ntype:
\nJSON response body fields:
\n\n","operationId":"OBPv2.0.0-addSocialMediaHandle","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_added","date_activated","type","customer_number","handle"],"properties":{"date_activated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_added":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"handle":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"date_activated":{"type":"string","format":"date-time"},"type":{"type":"string"},"customer_number":{"type":"string"},"handle":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules/policy/{policy}":{"get":{"tags":["ABAC"],"summary":"Get ABAC Rules by Policy","description":"Get all ABAC rules that belong to a specific policy.
\nMultiple rules can share the same policy. Rules with multiple policies (comma-separated)
\nwill be returned if any of their policies match the requested policy.
Documentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPOLICY: POLICY
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\nabac_rules: abac_rules
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nupdated_by_user_id: updated_by_user_id
\n","operationId":"OBPv6.0.0-getAbacRulesByPolicy","parameters":[{"name":"policy","in":"path","description":"The POLICY identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["abac_rules"],"properties":{"abac_rules":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","abac_rule_id","is_active","updated_by_user_id","created_by_user_id","description","rule_code","rule_name"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_by_user_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"abac_rules":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string"},"abac_rule_id":{"type":"string"},"is_active":{"type":"boolean"},"updated_by_user_id":{"type":"string","format":"date-time"},"created_by_user_id":{"type":"string"},"description":{"type":"string"},"rule_code":{"type":"string"},"rule_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/firehose/accounts/{accountid}/views/{viewid}/transactions":{"get":{"tags":["Transaction","Account-Firehose","Transaction-Firehose","FirehoseData"],"summary":"Get Firehose Transactions for Account","description":"Get Transactions for an Account that has a firehose View.
\nAllows bulk access to an account's transactions.
\nUser must have the CanUseFirehoseAtAnyBank Role
To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.
\nFor VIEW_ID try 'owner'
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","operationId":"OBPv3.0.0-getFirehoseTransactionsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metadata","details","transaction_attributes","this_account","id","other_account"],"properties":{"this_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","bank_routing","holders","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"holders":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","description","posted","new_balance","completed","value"],"properties":{"new_balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["narrative","tags","comments","images","where"],"properties":{"narrative":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"images":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","id","date","user","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"comments":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"other_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","metadata","bank_routing","holder","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"transaction_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"id":{"type":"string"},"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/owner/transaction-request-types/{cardano}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (CARDANO)","description":"For sandbox mode, it will use the Cardano Preprod Network.
\nThe accountId can be the wallet_id for now, as it uses cardano-wallet in the backend.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCARDANO: CARDANO
\nJSON request body fields:
\n\namount: 10.12
\nasset_name: asset_name
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\npassphrase: passphrase
\npolicy_id: policy_id
\nquantity: quantity
\nto:
\nunit: unit
\nvalue: 5987953
\nassets: assets
\n\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv6.0.0-createTransactionRequestCardano","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"cardano","in":"path","description":"The CARDANO identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","metadata","value","description","passphrase"],"properties":{"passphrase":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["amount","address","assets"],"properties":{"amount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["quantity","unit"],"properties":{"quantity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"unit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"assets":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["quantity","asset_name","policy_id"],"properties":{"quantity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"asset_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value1","key1"],"properties":{"value1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["string"],"properties":{"string":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"key1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"to":{"type":"object","properties":{"amount":{"type":"object","properties":{"quantity":{"type":"integer"},"unit":{"type":"string"}}},"address":{"type":"string"},"assets":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer"},"asset_name":{"type":"string"},"policy_id":{"type":"string"}}}}}},"metadata":{"type":"object","properties":{"value1":{"type":"object","properties":{"string":{"type":"string"}}},"key1":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"description":{"type":"string"},"passphrase":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/database/info":{"get":{"tags":["API"],"summary":"Get Mapper Database Info","description":"Get basic information about the Mapper Database.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","operationId":"OBPv4.0.0-getMapperDatabaseInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date","git_commit","name","version"],"properties":{"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"git_commit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"git_commit":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/double-entry-transaction":{"get":{"tags":["Transaction"],"summary":"Get Double Entry Transaction","description":"Get Double Entry Transaction
\nThis endpoint can be used to see the double entry transactions. It returns the bank_id, account_id and transaction_id
\nfor the debit end the credit transaction. The other side account can be a settlement account or an OBP account.
The endpoint also provide the transaction_request object which contains the bank_id, account_id and
\ntransaction_request_id of the transaction request at the origin of the transaction. Please note that if none
\ntransaction request is at the origin of the transaction, the transaction_request object will be null.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","operationId":"OBPv4.0.0-getDoubleEntryTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["debit_transaction","credit_transaction","transaction_request"],"properties":{"debit_transaction":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"credit_transaction":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transaction_request":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_request_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/users/{userid}/entitlement/{entitlementid}":{"delete":{"tags":["Role","User","Entitlement"],"summary":"Delete Entitlement","description":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv2.0.0-deleteEntitlement","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"entitlementid","in":"path","description":"The ENTITLEMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/regulated-entities/{regulatedentityid}/attributes/{regulatedentityattributeid}":{"get":{"tags":["Directory","API"],"summary":"Get Regulated Entity Attribute By ID","description":"Get a specific Regulated Entity Attribute by its REGULATED_ENTITY_ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-getRegulatedEntityAttributeById","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}},{"name":"regulatedentityattributeid","in":"path","description":"The REGULATEDENTITYATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["regulated_entity_attribute_id","name","attribute_type","value","regulated_entity_id","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Directory","API"],"summary":"Update Regulated Entity Attribute","description":"Update an existing Regulated Entity Attribute specified by ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-updateRegulatedEntityAttribute","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}},{"name":"regulatedentityattributeid","in":"path","description":"The REGULATEDENTITYATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attribute_type","value","is_active","name"],"properties":{"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"attribute_type":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["regulated_entity_attribute_id","name","attribute_type","value","regulated_entity_id","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Directory","API"],"summary":"Delete Regulated Entity Attribute","description":"Delete a Regulated Entity Attribute specified by REGULATED_ENTITY_ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteRegulatedEntityAttribute","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}},{"name":"regulatedentityattributeid","in":"path","description":"The REGULATEDENTITYATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts-held":{"get":{"tags":["Account","Account Information Service (AIS)","View-Custom","PSD2"],"summary":"Get Accounts Held","description":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","operationId":"OBPv3.0.0-getAccountsHeld","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","number","id","label","bank_id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/my/consents/{implicit}":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent (IMPLICIT)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv3.1.0-createConsentImplicit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"implicit","in":"path","description":"The IMPLICIT identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlements","everything","valid_from","views","consumer_id","time_to_live"],"properties":{"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consent_id","status","jwt"],"properties":{"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/meetings/{meetingid}":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meeting","description":"Get Meeting specified by BANK_ID / MEETING_ID
\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","operationId":"OBPv3.1.0-getMeeting","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"meetingid","in":"path","description":"The MEETINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["present","invitees","bank_id","when","provider_id","purpose_id","keys","creator","meeting_id"],"properties":{"present":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["staff_user_id","customer_user_id"],"properties":{"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"creator":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"invitees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","contact_details"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contact_details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"meeting_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"keys":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_token","session_id","staff_token"],"properties":{"customer_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"session_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/holding-accounts":{"get":{"tags":["Account"],"summary":"Get Holding Accounts By Releaser","description":"Return the first Holding Account linked to the given releaser account via account attribute RELEASER_ACCOUNT_ID.
\nResponse is wrapped in a list and includes account attributes.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\ntype:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv6.0.0-getHoldingAccountByReleaser","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","type","account_rules","bank_id","owners","account_attributes","label","balance","number","id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_rules":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"type":{"type":"string"},"account_rules":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/{userid}":{"delete":{"tags":["User"],"summary":"Delete a User","description":"Delete a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteUser","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/attribute":{"post":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Create Customer Attribute","description":"Create Customer Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createCustomerAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/SimonCovid/{simoncovidid}":{"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid by id","description":"Get SimonCovid by id.
\nLet's put Covid99 stuff here
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"SimonCovid"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleSimonCovid_","parameters":[{"name":"simoncovidid","in":"path","description":"The SIMONCOVIDID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid"],"properties":{"simon_covid":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid_id","name","number"],"properties":{"simon_covid_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Update SimonCovid","description":"Update SimonCovid.
\nLet's put Covid99 stuff here
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"SimonCovid"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateSimonCovid_","parameters":[{"name":"simoncovidid","in":"path","description":"The SIMONCOVIDID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid"],"properties":{"simon_covid":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid_id","name","number"],"properties":{"simon_covid_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Delete SimonCovid by id","description":"Delete SimonCovid by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"SimonCovid"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteSimonCovid_","parameters":[{"name":"simoncovidid","in":"path","description":"The SIMONCOVIDID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid"],"properties":{"simon_covid":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid_id","name","number"],"properties":{"simon_covid_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/customers/{customerid}/children":{"get":{"tags":["Customer"],"summary":"Get Customer Children","description":"Get the child (subsidiary) customers of a parent customer.
\nReturns a list of customers whose parent_customer_id matches the specified CUSTOMER_ID.
\nThis is useful for corporate banking where a corporate customer may have subsidiary customers.
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCustomerChildren","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-entities/{dynamicentityid}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete Bank Level Dynamic Entity","description":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nFor more information see here/
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteBankLevelDynamicEntity","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consents/banks/{bankid}":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consents at Bank","description":"This endpoint gets the Consents at Bank by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n1 limit (for pagination: defaults to 50) eg:limit=200
\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n3 consumer_id (ignore if omitted)
\n4 user_id (ignore if omitted)
\n5 status (ignore if omitted)
\neg: /management/consents/banks/BANK_ID?&consumer_id=78&limit=10&offset=10
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nnote: note
\nnumber_of_rows: number_of_rows
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nfrequency_per_day: frequency_per_day
\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\nprovider: ETHEREUM
\n\nremaining_requests: remaining_requests
\n\n","operationId":"OBPv5.1.0-getConsentsAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number_of_rows","consents"],"properties":{"number_of_rows":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","created_by_user_id","api_standard","consumer_id","last_usage_date","last_action_date","consent_reference_id","jwt_payload","note","provider_id","status","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt_payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["aud","views","nbf","exp","iss","iat","access","createdByUserId","email","jti","name","request_headers","entitlements","sub"],"properties":{"nbf":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_headers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["values","name"],"properties":{"values":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"jti":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"exp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"createdByUserId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"iat":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sub":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"aud":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iss":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["availableAccounts","transactions","accounts","balances"],"properties":{"availableAccounts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bban","msisdn","maskedPan","iban","currency","pan"],"properties":{"msisdn":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maskedPan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pan":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_reference_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"note":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"number_of_rows":{"type":"integer"},"consents":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"note":{"type":"string"},"provider_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/certs":{"get":{"tags":["API","Account Information Service (AIS)","PSD2"],"summary":"Get JSON Web Key (JWK)","description":"Get the server's public JSON Web Key (JWK) set and certificate chain.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\ne:
\nkid:
\nkty:
\nn:
\nuse:
\n","operationId":"OBPv3.1.0-getServerJWK","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["kid","use","n","e","kty"],"properties":{"e":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"n":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kid":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"kid":{"type":"string"},"use":{"type":"string"},"n":{"type":"string"},"e":{"type":"string"},"kty":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v2.0.0/banks/{bankid}/customers/{customerid}/kyc_documents/{kycdocumentid}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Document","description":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","operationId":"OBPv2.0.0-addKycDocument","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"kycdocumentid","in":"path","description":"The KYCDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["issue_place","expiry_date","issue_date","customer_number","type","number"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_place":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"expiry_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"issue_place":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"issue_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"type":{"type":"string"},"number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["expiry_date","issue_place","customer_id","type","issue_date","number","bank_id","customer_number","id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_place":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"expiry_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/api-collections/sharable/{apicollectionid}":{"get":{"tags":["Api-Collection"],"summary":"Get Sharable Api Collection By Id","description":"Get Sharable Api Collection By Id.
\nUser Authentication is Optional. The User need not be logged in.
URL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getSharableApiCollectionById","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/account-access/revoke":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"summary":"Revoke User access to View","description":"Revoke the User identified by USER_ID access to the view identified.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated..
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n","operationId":"OBPv5.1.0-revokeUserAccessToViewById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["view_id","user_id"],"properties":{"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"view_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["revoked"],"properties":{"revoked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"revoked":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collections":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collections","description":"Get all the apiCollections for logged in user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getMyApiCollections","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collections"],"properties":{"api_collections":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Api-Collection"],"summary":"Create My Api Collection","description":"Create Api Collection for logged in user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napi_collection_name: Favourites
\nis_sharable: is_sharable
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-createMyApiCollection","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","api_collection_name","is_sharable"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collections/{apicollectionname}/api-collection-endpoints/{operationid}":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collection Endpoint","description":"Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-getMyApiCollectionEndpoint","parameters":[{"name":"apicollectionname","in":"path","description":"The APICOLLECTIONNAME identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Api-Collection"],"summary":"Delete My Api Collection Endpoint","description":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteMyApiCollectionEndpoint","parameters":[{"name":"apicollectionname","in":"path","description":"The APICOLLECTIONNAME identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/current/customers/customer_ids":{"get":{"tags":["Customer","User"],"summary":"Get Customers for Current User (IDs only)","description":"Gets all Customers Ids that are linked to a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv5.1.0-getCustomersForUserIdsOnly","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","customer_attributes","last_ok_date","face_image","credit_limit","employment_status","email","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","date_of_birth","legal_name","title","dob_of_dependants","branch_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"last_ok_date":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at Bank","description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","operationId":"OBPv2.0.0-publicAccountsAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["label","id","bank_id","views_available"],"properties":{"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","id","is_public"],"properties":{"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/development/call_context":{"get":{"tags":["API"],"summary":"Get the Call Context of a current call","description":"Get the Call Context of the current call.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getCallContext","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/consumer/current/consents/{consentid}":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consent By Consent Id via Consumer","description":"This endpoint gets the Consent By consent id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","operationId":"OBPv5.1.0-getConsentByConsentIdViaConsumer","parameters":[{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access","consent_request_id","consent_id","status","jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/signal/channels/{channelname}/messages":{"get":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"Get Signal Messages","description":"Fetch messages from a signal channel with offset/limit pagination.
\nSignal channels provide short-lived, Redis-backed messaging designed for AI agent discovery
\nand coordination, but usable by any authenticated OBP consumer.
Messages are returned oldest-first.
\nPrivacy filtering is applied server-side: you will only see broadcast messages (no to_user_id)
\nand private messages addressed to you (to_user_id matches your user ID) or sent by you.
Use the offset parameter to poll for new messages by tracking your position.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCHANNEL_NAME: CHANNEL_NAME
\nJSON response body fields:
\nchannel_name: channel_name
\nhas_more: has_more
\nmessage_id: message_id
\nmessage_type: message_type
\n\npayload: payload
\nsender_consumer_id: sender_consumer_id
\nsender_user_id: sender_user_id
\ntimestamp: timestamp
\ntotal_count: total_count
\nto_user_id: to_user_id
\n","operationId":"OBPv6.0.0-getSignalMessages","parameters":[{"name":"channelname","in":"path","description":"The CHANNELNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["messages","channel_name","has_more","total_count"],"properties":{"messages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message_id","sender_user_id","message_type","timestamp","sender_consumer_id","channel_name","payload"],"properties":{"sender_consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"timestamp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_name","capabilities"],"properties":{"agent_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"capabilities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sender_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_more":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"total_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"message_id":{"type":"string"},"sender_user_id":{"type":"string"},"message_type":{"type":"string"},"timestamp":{"type":"string"},"sender_consumer_id":{"type":"string"},"channel_name":{"type":"string"},"payload":{"type":"object","properties":{"agent_name":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}},"channel_name":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"Publish Signal Message","description":"Publish a message to a signal channel.
\nSignal channels provide short-lived, Redis-backed messaging for lightweight coordination between
\nAI agents and other OBP consumers. Messages are not persisted to a database.
Channels are auto-created on first publish and expire after a configurable TTL (default 1 hour).
\nMessages are capped at a configurable maximum per channel (default 1000).
The payload field accepts any valid JSON content.
\nSet to_user_id to send a private message visible only to the sender and recipient.
\nLeave to_user_id empty for a broadcast message visible to all channel readers.
Authentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCHANNEL_NAME: CHANNEL_NAME
\nJSON request body fields:
\npayload: payload
\nmessage_type: message_type
\nto_user_id: to_user_id
\nJSON response body fields:
\nchannel_message_count: channel_message_count
\nchannel_name: channel_name
\nmessage_id: message_id
\ntimestamp: timestamp
\n","operationId":"OBPv6.0.0-publishSignalMessage","parameters":[{"name":"channelname","in":"path","description":"The CHANNELNAME identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message_type","payload"],"properties":{"message_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_name","capabilities"],"properties":{"agent_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"capabilities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"message_type":{"type":"string"},"payload":{"type":"object","properties":{"agent_name":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message_id","timestamp","channel_message_count","channel_name"],"properties":{"message_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"timestamp":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channel_message_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message_id":{"type":"string"},"timestamp":{"type":"string"},"channel_message_count":{"type":"integer"},"channel_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/corporate-customers/{customerid}":{"get":{"tags":["Corporate-Customer","Customer"],"summary":"Get Corporate Customer by CUSTOMER_ID","description":"Gets the Corporate Customer specified by CUSTOMER_ID.
\nReturns 404 if the customer exists but is not of type CORPORATE or SUBSIDIARY.
\nUse the generic /customers/CUSTOMER_ID endpoint for any customer type.
Date Format:
\ndate_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv6.0.0-getCorporateCustomerByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","date_of_birth","customer_attributes","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"last_ok_date":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/signal/channels":{"get":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"List Signal Channels","description":"Signal channels provide short-lived, Redis-backed messaging designed for AI agent discovery and coordination, but usable by any authenticated OBP consumer.
\nMessages are ephemeral and will expire after the configured TTL (default 1 hour).
This endpoint lists active signal channels.
\nOnly channels that contain at least one broadcast message (no to_user_id) are listed.
\nPrivate-only channels are not shown.
Authentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nchannel_name: channel_name
\nchannels: channels
\nmessage_count: message_count
\nttl_seconds: ttl_seconds
\n","operationId":"OBPv6.0.0-getSignalChannels","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["channels"],"properties":{"channels":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["ttl_seconds","message_count","channel_name"],"properties":{"ttl_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"ttl_seconds":{"type":"integer"},"message_count":{"type":"integer"},"channel_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/api-products/{apiproductcode}":{"get":{"tags":["API","Api-Product"],"summary":"Get Api Product","description":"Get an Api Product by BANK_ID and API_PRODUCT_CODE.
\nReturns the Api Product with its attributes.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\napi_product_id: api_product_id
\nbank_id: gh.29.uk
\n\ncollection_id: collection_id
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nmonthly_subscription_amount: monthly_subscription_amount
\nmonthly_subscription_currency: monthly_subscription_currency
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_api_product_code: parent_api_product_code
\n\n\n\n\n\n\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nis_active: false
\n","operationId":"OBPv6.0.0-getApiProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","monthly_subscription_amount","monthly_subscription_currency","category","per_day_call_limit","per_minute_call_limit","description","attributes","per_week_call_limit","per_second_call_limit","parent_api_product_code","per_month_call_limit","bank_id","collection_id","terms_and_conditions_url","more_info_url","api_product_id","api_product_code","per_hour_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"category":{"type":"string"},"per_day_call_limit":{"type":"integer"},"per_minute_call_limit":{"type":"integer"},"description":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}},"per_week_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_month_call_limit":{"type":"integer"},"bank_id":{"type":"string"},"collection_id":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"more_info_url":{"type":"string"},"api_product_id":{"type":"string"},"api_product_code":{"type":"string"},"per_hour_call_limit":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API","Api-Product"],"summary":"Create or Update Api Product","description":"Create or Update an Api Product for the Bank.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\napi_product_id: api_product_id
\nbank_id: gh.29.uk
\n\ncollection_id: collection_id
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nmonthly_subscription_amount: monthly_subscription_amount
\nmonthly_subscription_currency: monthly_subscription_currency
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_api_product_code: parent_api_product_code
\n\n\n\n\n\n\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nis_active: false
\n","operationId":"OBPv6.0.0-createOrUpdateApiProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","category","monthly_subscription_currency","description","monthly_subscription_amount","terms_and_conditions_url","collection_id","per_month_call_limit","per_second_call_limit","parent_api_product_code","per_minute_call_limit","per_hour_call_limit","more_info_url","per_week_call_limit","per_day_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"description":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"collection_id":{"type":"string"},"per_month_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_minute_call_limit":{"type":"integer"},"per_hour_call_limit":{"type":"integer"},"more_info_url":{"type":"string"},"per_week_call_limit":{"type":"integer"},"per_day_call_limit":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","monthly_subscription_amount","monthly_subscription_currency","category","per_day_call_limit","per_minute_call_limit","description","attributes","per_week_call_limit","per_second_call_limit","parent_api_product_code","per_month_call_limit","bank_id","collection_id","terms_and_conditions_url","more_info_url","api_product_id","api_product_code","per_hour_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"category":{"type":"string"},"per_day_call_limit":{"type":"integer"},"per_minute_call_limit":{"type":"integer"},"description":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}},"per_week_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_month_call_limit":{"type":"integer"},"bank_id":{"type":"string"},"collection_id":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"more_info_url":{"type":"string"},"api_product_id":{"type":"string"},"api_product_code":{"type":"string"},"per_hour_call_limit":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["API","Api-Product"],"summary":"Create Api Product","description":"Create an Api Product for the Bank.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\ncollection_id: collection_id
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nmonthly_subscription_amount: monthly_subscription_amount
\nmonthly_subscription_currency: monthly_subscription_currency
\nmore_info_url: www.example.com/abc
\nparent_api_product_code: parent_api_product_code
\n\n\n\n\n\n\nterms_and_conditions_url: www.example.com/xyz
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\napi_product_id: api_product_id
\nbank_id: gh.29.uk
\n\ncollection_id: collection_id
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nmonthly_subscription_amount: monthly_subscription_amount
\nmonthly_subscription_currency: monthly_subscription_currency
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_api_product_code: parent_api_product_code
\n\n\n\n\n\n\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nis_active: false
\n","operationId":"OBPv6.0.0-createApiProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","category","monthly_subscription_currency","description","monthly_subscription_amount","terms_and_conditions_url","collection_id","per_month_call_limit","per_second_call_limit","parent_api_product_code","per_minute_call_limit","per_hour_call_limit","more_info_url","per_week_call_limit","per_day_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"description":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"collection_id":{"type":"string"},"per_month_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_minute_call_limit":{"type":"integer"},"per_hour_call_limit":{"type":"integer"},"more_info_url":{"type":"string"},"per_week_call_limit":{"type":"integer"},"per_day_call_limit":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","monthly_subscription_amount","monthly_subscription_currency","category","per_day_call_limit","per_minute_call_limit","description","attributes","per_week_call_limit","per_second_call_limit","parent_api_product_code","per_month_call_limit","bank_id","collection_id","terms_and_conditions_url","more_info_url","api_product_id","api_product_code","per_hour_call_limit"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monthly_subscription_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"monthly_subscription_amount":{"type":"string"},"monthly_subscription_currency":{"type":"string"},"category":{"type":"string"},"per_day_call_limit":{"type":"integer"},"per_minute_call_limit":{"type":"integer"},"description":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}},"per_week_call_limit":{"type":"integer"},"per_second_call_limit":{"type":"integer"},"parent_api_product_code":{"type":"string"},"per_month_call_limit":{"type":"integer"},"bank_id":{"type":"string"},"collection_id":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"more_info_url":{"type":"string"},"api_product_id":{"type":"string"},"api_product_code":{"type":"string"},"per_hour_call_limit":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["API","Api-Product"],"summary":"Delete Api Product","description":"Delete an Api Product by BANK_ID and API_PRODUCT_CODE.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteApiProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.2.0/message-docs/{connector}":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs","description":"These message docs provide example messages sent by OBP to the (RabbitMq) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
\nIntegrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
\nCONNECTOR: rest_vMar2019, stored_procedure_vDec2019 ...
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nprocess: obp.getBank
\n\n\n\n\n\n\nrequiredFieldInfo: false
\n","operationId":"OBPv2.2.0-getMessageDocs","parameters":[{"name":"connector","in":"path","description":"The CONNECTOR identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message_docs"],"properties":{"message_docs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependent_endpoints","inbound_topic","requiredFieldInfo","outbound_topic","outboundAvroSchema","message_format","adapter_implementation","example_inbound_message","process","inboundAvroSchema","description","example_outbound_message"],"properties":{"adapter_implementation":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group","suggested_order"],"properties":{"group":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"suggested_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"outboundAvroSchema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jsonString"],"properties":{"jsonString":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jsonString"],"properties":{"jsonString":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"inboundAvroSchema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jsonString"],"properties":{"jsonString":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"requiredFieldInfo":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["data.bankId"],"properties":{"data.bankId":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jsonString"],"properties":{"jsonString":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"dependent_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","version"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"message_docs":{"type":"array","items":{"type":"object","properties":{"dependent_endpoints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}},"inbound_topic":{"type":"string"},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"type":"string"}}}},"outbound_topic":{"type":"string"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"message_format":{"type":"string"},"adapter_implementation":{"type":"object","properties":{"group":{"type":"string"},"suggested_order":{"type":"integer"}}},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}},"process":{"type":"string"},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"description":{"type":"string"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/owner/transaction-request-types/{ethsendtransaction}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (ETH_SEND_TRANSACTION)","description":"Send ETH via Ethereum JSON-RPC.
\nAccountId should hold the 0x address for now.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nETH_SEND_TRANSACTION: ETH_SEND_TRANSACTION
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nparams: params
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv6.0.0-createTransactionRequestEthereumeSendTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"ethsendtransaction","in":"path","description":"The ETHSENDTRANSACTION identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","description","to"],"properties":{"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"description":{"type":"string"},"to":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/branches/{branchid}":{"delete":{"tags":["Branch"],"summary":"Delete Branch","description":"Delete Branch from given Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteBranch","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"branchid","in":"path","description":"The BRANCHID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system-views/{viewid}/permissions/{permissionname}":{"delete":{"tags":["View-System"],"summary":"Delete Permission to a System View","description":"Delete Permission to a System View
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPERMISSION_NAME: PERMISSION_NAME
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteSystemViewPermission","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"permissionname","in":"path","description":"The PERMISSIONNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/logins/direct":{"post":{"tags":["User"],"summary":"Direct Login","description":"DirectLogin is a simple authentication flow. You POST your credentials (username, password, and consumer key)
\nto the DirectLogin endpoint and receive a token in return.
This is an alias to the DirectLogin endpoint that includes the standard API versioning prefix.
\nThis endpoint requires the following header:
\nDirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY\nNote: You can also use the Authorization header (Authorization: DirectLogin username=...) but the DirectLogin header is preferred.
\nThe token returned can then be used in subsequent API calls using the header:
\nDirectLogin: token=YOUR_TOKEN\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\nJSON response body fields:
\n\n","operationId":"OBPv6.0.0-directLoginEndpoint","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["token"],"properties":{"token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"token":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/consents/{consentid}":{"delete":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Revoke My Consent","description":"Revoke Consent for current user specified by CONSENT_ID
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
Please note that this endpoint only supports the case:: "The user explicitly wishes to revoke the application’s access"
\nOBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-revokeMyConsent","parameters":[{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.1.0/banks/{bankid}/users/{userid}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for User at Bank","description":"Get Entitlements specified by BANK_ID and USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","operationId":"OBPv2.1.0-getEntitlementsByBankAndUser","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-resource-docs/endpoint-code":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"Create Dynamic Resource Doc endpoint code","description":"Create a Dynamic Resource Doc endpoint code.
\ncopy the response and past to PractiseEndpoint, So you can have the benefits of
\nauto compilation and debug
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\ncode: 125
\n","operationId":"OBPv4.0.0-buildDynamicEndpointTemplate","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["request_verb","example_request_body","success_response_body","request_url"],"properties":{"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"request_url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["code"],"properties":{"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"code":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/users/current/auth-context-updates/{authcontextupdateid}/challenge":{"post":{"tags":["User"],"summary":"Answer User Auth Context Update Challenge","description":"Answer User Auth Context Update Challenge.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","operationId":"OBPv5.0.0-answerUserAuthContextUpdateChallenge","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"authcontextupdateid","in":"path","description":"The AUTHCONTEXTUPDATEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["answer"],"properties":{"answer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"answer":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_auth_context_update_id","consumer_id","key","status","value","user_id"],"properties":{"user_auth_context_update_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute":{"post":{"tags":["Bank","Bank-Attribute","Attribute"],"summary":"Create Bank Attribute","description":"Create Bank Attribute
\nTypical product attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-createBankAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value","is_active","type"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","bank_id","type","name","is_active","bank_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/banks/{bankid}/consents/{consentid}":{"put":{"tags":["Consent","Account Information Service (AIS)"],"summary":"Update Consent Status by CONSENT_ID","description":"This endpoint is used to update the Status of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-updateConsentStatusByConsent","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collection-ids/{apicollectionid}/api-collection-endpoints/{operationid}":{"delete":{"tags":["Api-Collection"],"summary":"Delete My Api Collection Endpoint By Id","description":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/banks/{bankid}/account-web-hooks":{"get":{"tags":["Webhook","Bank"],"summary":"Get Account Webhooks","description":"Get Account Webhooks.
\nPossible custom URL parameters for pagination:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n","operationId":"OBPv3.1.0-getAccountWebhooks","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_hooks"],"properties":{"web_hooks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","http_method","is_active","bank_id","http_protocol","account_webhook_id","trigger_name","account_id","url"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"web_hooks":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-requests":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"summary":"Get Transaction Requests","description":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
We support query transaction request by attribute
\nURL params example:/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests?invoiceNumber=123&referenceNumber=456
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\ntransaction_requests_with_charges:
\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv5.1.0-getTransactionRequests","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_requests_with_charges"],"properties":{"transaction_requests_with_charges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenge","status","end_date","charge","transaction_ids","from","details","start_date","id"],"properties":{"challenge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","allowed_attempts","id"],"properties":{"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_requests_with_charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transaction-requests/{transactionrequestid}/attributes":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attributes","description":"Get Transaction Request Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntransaction_request_attributes: transaction_request_attributes
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getTransactionRequestAttributes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_request_attributes"],"properties":{"transaction_request_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","transaction_request_attribute_id","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_request_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/users/current/auth-context-updates/{scamethod}":{"post":{"tags":["User"],"summary":"Create User Auth Context Update Request","description":"Create User Auth Context Update Request.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
URL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON request body fields:
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","operationId":"OBPv5.0.0-createUserAuthContextUpdateRequest","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"scamethod","in":"path","description":"The SCAMETHOD identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["key","value"],"properties":{"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_auth_context_update_id","consumer_id","key","status","value","user_id"],"properties":{"user_auth_context_update_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/system-dynamic-entities/{dynamicentityid}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete System Level Dynamic Entity","description":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nFor more information see here/
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteSystemDynamicEntity","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/user-entitlements":{"post":{"tags":["Role","Entitlement","User","DAuth"],"summary":"Create (DAuth) User with Roles","description":"This endpoint is used as part of the DAuth solution to grant Entitlements for Roles to a smart contract on the blockchain.
\nPut the smart contract address in username
\nFor provider use "dauth"
\nThis endpoint will create the User with username and provider if the User does not already exist.
\nThen it will create Entitlements i.e. grant Roles to the User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\ni.e. Entitlements are used to create / consume system or bank level resources where as views / account access are used to consume / create customer level resources.
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nNote: The Roles actually granted will depend on the Roles that the calling user has.
\nIf you try to grant Entitlements to a user that already exist (duplicate entitilements) you will get an error.
\nFor information about DAuth see below:
\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n) your-RSA-key-pair
\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://apisandbox.openbankproject.com/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nbank_id: gh.29.uk
\nprovider: ETHEREUM
\n\nroles: CanCreateMyUser
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-createUserWithRoles","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles","provider","username"],"properties":{"roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"provider":{"type":"string"},"username":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_id","bank_id","role_name","user_id"],"properties":{"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{transactionrequesttype}/transaction-requests/{transactionrequestid}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","description":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
\n1)TRANSACTION_REQUEST_TYPE : is the same as createTransactionRequest request URL .
2)TRANSACTION_REQUEST_ID : is the id field in createTransactionRequest response body.
3) id : is challenge.id field in createTransactionRequest response body.
4) answer : must be 123 in case that Strong Customer Authentication method for OTP challenge is dummy.
\nFor instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy
\nPossible values are dummy,email and sms
\nIn CBS mode, the answer can be got by phone message or other SCA methods.
Note that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.
\nOTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.
Single or Multiple authorisations
\nOBP allows single or multi party authorisations.
\nSingle party authorisation:
\nIn the case that only one person needs to authorise i.e. answer a security challenge we have the following change of state of a transaction request:
\nINITIATED => COMPLETED
Multiparty authorisation:
\nIn the case that multiple parties (n persons) need to authorise a transaction request i.e. answer security challenges, we have the followings state flow for a transaction request:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in the case of a correct answer but the user is different than expected the challenge will fail.
\nRule for calculating number of security challenges:
\nIf Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission can_add_transaction_request_to_any_account=true)
\nIn the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nTRANSACTION_REQUEST_TYPE: SEPA
\nVIEW_ID: owner
\nJSON request body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nadditional_information: additional_information
\nreason_code: reason_code
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-answerTransactionRequestChallenge","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequesttype","in":"path","description":"The TRANSACTIONREQUESTTYPE identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["additional_information","answer","reason_code","id"],"properties":{"additional_information":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"answer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reason_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"additional_information":{"type":"string"},"answer":{"type":"string"},"reason_code":{"type":"string"},"id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenge","status","end_date","charge","transaction_ids","from","details","start_date","id"],"properties":{"challenge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","allowed_attempts","id"],"properties":{"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/cache/info":{"get":{"tags":["Cache","System","API"],"summary":"Get Cache Information","description":"Returns detailed cache information for all namespaces:
\nThis endpoint helps monitor cache usage and identify which namespaces contain the most data.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ncurrent_version: current_version
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nkey_count: key_count
\nnamespace_id: namespace_id
\nnamespaces: namespaces
\nprefix: prefix
\nredis_available: redis_available
\nstorage_location: storage_location
\ntotal_keys: total_keys
\nttl_info: ttl_info
\n","operationId":"OBPv6.0.0-getCacheInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["total_keys","redis_available","namespaces"],"properties":{"total_keys":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redis_available":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"namespaces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["storage_location","description","key_count","prefix","current_version","ttl_info","category","namespace_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"prefix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"storage_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"current_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"namespace_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"ttl_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"total_keys":{"type":"integer"},"redis_available":{"type":"boolean"},"namespaces":{"type":"array","items":{"type":"object","properties":{"storage_location":{"type":"string"},"description":{"type":"string"},"key_count":{"type":"integer"},"prefix":{"type":"string"},"current_version":{"type":"integer"},"ttl_info":{"type":"string"},"category":{"type":"string"},"namespace_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/users/{userid}/refresh":{"post":{"tags":["User"],"summary":"Refresh User","description":"The endpoint is used for updating the accounts, views, account holders for the user.
\nAs to the Json body, you can leave it as Empty.
\nThis call will get data from backend, no need to prepare the json body in api side.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nJSON response body fields:
\nduration_time: 60
\n","operationId":"OBPv3.1.0-refreshUser","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["duration_time"],"properties":{"duration_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"duration_time":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/credit_cards/orders":{"get":{"tags":["Card"],"summary":"Get status of Credit Card order ","description":"Get status of Credit Card orders
\nGet all orders
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\ncard_type: Credit
\n\n\n","operationId":"OBPv3.1.0-getStatusOfCreditCardOrder","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["cards"],"properties":{"cards":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["use_type","card_description","card_type"],"properties":{"use_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"use_type":{"type":"string"},"card_description":{"type":"string"},"card_type":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/spaces":{"get":{"tags":["User"],"summary":"Get My Spaces","description":"Get My Spaces.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_ids: bank_ids
\n","operationId":"OBPv4.0.0-getMySpaces","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_ids"],"properties":{"bank_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"bank_ids":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/correlated-users":{"get":{"tags":["Customer"],"summary":"Get Correlated User Info by Customer","description":"Get Correlated User Info by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\ninsert_date: 2020-01-27
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nvalue: 5987953
\n\n\n","operationId":"OBPv4.0.0-getCorrelatedUsersInfoByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["users","customer"],"properties":{"users":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","user_attributes","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"user_attributes":{"type":"array","items":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}}},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/groups/{groupid}/entitlements":{"get":{"tags":["Group","Entitlement"],"summary":"Get Group Entitlements","description":"Get all entitlements that have been granted from a specific group.
\nThis returns all entitlements where the group_id matches the specified GROUP_ID.
\nRequires:
\n- CanGetEntitlementsForAnyBank
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nGROUP_ID: GROUP_ID
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ngroup_id: group_id
\nprocess: obp.getBank
\n","operationId":"OBPv6.0.0-getGroupEntitlements","parameters":[{"name":"groupid","in":"path","description":"The GROUPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlements"],"properties":{"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["process","username","bank_id","user_id","entitlement_id","group_id","role_name"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"process":{"type":"string"},"username":{"type":"string"},"bank_id":{"type":"string"},"user_id":{"type":"string"},"entitlement_id":{"type":"string"},"group_id":{"type":"string"},"role_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/view-permissions":{"get":{"tags":["View-System","View-Custom"],"summary":"Get View Permissions","description":"Get a list of all available view permissions.
\nThis endpoint returns all the available permissions that can be assigned to views,
\norganized by category. These permissions control what actions and data can be accessed
\nthrough a view.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe response contains all available view permission names that can be used in the
\nallowed_actions field when creating or updating custom views.
JSON response body fields:
\n\npermission: permission
\n\n","operationId":"OBPv6.0.0-getViewPermissions","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["permission","category"],"properties":{"permission":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"object","properties":{"permission":{"type":"string"},"category":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/{customerid}/attributes/{customerattributeid}":{"delete":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Delete Customer Attribute","description":"Delete Customer Attribute
\nCustomerAttributes are used to enhance the OBP Customer object with Bank specific entities.
\nDelete a Customer Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteCustomerAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"customerattributeid","in":"path","description":"The CUSTOMERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-endpoints/{dynamicendpointid}":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Bank Level Dynamic Endpoint","description":"Get a Bank Level Dynamic Endpoint.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-getBankLevelDynamicEndpoint","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Bank Level Dynamic Endpoint","description":"Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteBankLevelDynamicEndpoint","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/products/{productcode}/attributes/{accountattributeid}":{"put":{"tags":["Account","Account-Attribute","Attribute"],"summary":"Update Account Attribute","description":"Update Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv3.1.0-updateAccountAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"accountattributeid","in":"path","description":"The ACCOUNTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_instance_code","type","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/corporate-customers":{"get":{"tags":["Corporate-Customer","Customer"],"summary":"Get Corporate Customers at Bank","description":"Get Corporate Customers at Bank.
\nReturns a list of customers with customer_type CORPORATE or SUBSIDIARY at the specified bank.
\nDate Format:
\ndate_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD
Query Parameters:
\n- limit: Maximum number of customers to return (optional)
\n- offset: Number of customers to skip for pagination (optional)
\n- sort_direction: Sort direction - ASC or DESC (optional)
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCorporateCustomersAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Corporate-Customer","Customer"],"summary":"Create Corporate Customer","description":"Create a corporate customer.
\nThis endpoint is specifically for creating corporate customers.
\nIndividual-oriented fields (relationship_status, dependants, highest_education_attained, employment_status, name_suffix, date_of_birth, face_image, title) are not available on this endpoint.
Required Fields:
\n- legal_name: The corporate entity's legal name
\n- mobile_phone_number: The corporate entity's phone number
Optional Fields:
\n- customer_number: If not provided, a random number will be generated
\n- email, credit_rating, credit_limit, kyc_status, last_ok_date, branch_id
\n- customer_type: CORPORATE (default) or SUBSIDIARY
\n- parent_customer_id: For SUBSIDIARY customers, the customer_id of the parent customer
Validations:
\n- customer_number cannot contain :::: characters
\n- customer_number must be unique for the bank
\n- customer_type must be CORPORATE or SUBSIDIARY
\n- parent_customer_id must reference an existing customer if provided
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\n\nbranch_id: DERBY6
\n\n\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\n\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-createCorporateCustomer","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["last_ok_date","customer_type","credit_limit","credit_rating","email","customer_number","kyc_status","legal_name","branch_id","mobile_phone_number"],"properties":{"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"last_ok_date":{"type":"string","format":"date-time"},"customer_type":{"type":"string"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"email":{"type":"string"},"customer_number":{"type":"string"},"kyc_status":{"type":"boolean"},"legal_name":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/balances":{"get":{"tags":["Account","Balance"],"summary":"Get All Bank Account Balances","description":"Get all Balances for a Bank Account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbalances: balances
\nbank_id: gh.29.uk
\n","operationId":"OBPv5.1.0-getAllBankAccountBalances","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balances"],"properties":{"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","bank_id","balance_id","account_id","balance_type"],"properties":{"balance_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"balances":{"type":"array","items":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Account","Balance"],"summary":"Create Bank Account Balance","description":"Create a new Balance for a Bank Account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nbalance_amount: 50.89
\nbalance_type: openingBooked
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","operationId":"OBPv5.1.0-createBankAccountBalance","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","balance_type"],"properties":{"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"balance_amount":{"type":"string"},"balance_type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","bank_id","balance_id","account_id","balance_type"],"properties":{"balance_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{userid}/entitlements-and-permissions":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements and Permissions for a User","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\n\n","operationId":"OBPv5.1.0-getEntitlementsAndPermissions","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","views","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/json-schema-validations/{operationid}":{"get":{"tags":["JSON-Schema-Validation"],"summary":"Get a JSON Schema Validation","description":"Get a JSON Schema Validation by operation_id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv6.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","operationId":"OBPv4.0.0-getJsonSchemaValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema","operation_id"],"properties":{"json_schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["JSON-Schema-Validation"],"summary":"Update a JSON Schema Validation","description":"Update a JSON Schema Validation.
\nIntroduction:
\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\nTo use this endpoint, please supply a valid json-schema in the request body.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv6.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","operationId":"OBPv4.0.0-updateJsonSchemaValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema","operation_id"],"properties":{"json_schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["JSON-Schema-Validation"],"summary":"Create a JSON Schema Validation","description":"Create a JSON Schema Validation.
\nIntroduction:
\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\nTo use this endpoint, please supply a valid json-schema in the request body.
\nNote: It might take a few minutes for the newly created JSON Schema to take effect!
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON request body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\nmaxLength: maxLength
\nminLength: minLength
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv6.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","operationId":"OBPv4.0.0-createJsonSchemaValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema","operation_id"],"properties":{"json_schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["JSON-Schema-Validation"],"summary":"Delete a JSON Schema Validation","description":"Delete a JSON Schema Validation by operation_id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteJsonSchemaValidation","parameters":[{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user_customer_links":{"post":{"tags":["Customer","User"],"summary":"Create User Customer Link","description":"Link a User to a Customer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-createUserCustomerLinks","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","user_id"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_customer_link_id","customer_id","is_active","date_inserted","user_id"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_inserted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_customer_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"date_inserted":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/transactions/{transactionid}/balancing-transaction":{"get":{"tags":["Transaction"],"summary":"Get Balancing Transaction","description":"Get Balancing Transaction
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","operationId":"OBPv4.0.0-getBalancingTransaction","parameters":[{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["debit_transaction","credit_transaction","transaction_request"],"properties":{"debit_transaction":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"credit_transaction":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transaction_request":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","transaction_request_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/comments":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Comments","description":"Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv1.2.1-getCommentsForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["comments"],"properties":{"comments":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Comment","description":"Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
\n${authenticationRequiredMessage(false)}
\nAuthentication is required since the comment is linked with the user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","operationId":"OBPv1.2.1-addCommentForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/providers":{"get":{"tags":["User"],"summary":"Get Providers","description":"Get the list of authentication providers that have been used to create users on this OBP instance.
\nThis endpoint returns a distinct list of provider values from the resource_user table.
\nProviders may include:
\n* Local OBP provider (e.g., "http://127.0.0.1:8080")
\n* OAuth 2.0 / OpenID Connect providers (e.g., "google.com", "microsoft.com")
\n* Custom authentication providers
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nproviders: providers
\n","operationId":"OBPv6.0.0-getProviders","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["providers"],"properties":{"providers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"providers":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/images":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Images","description":"Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
\nAuthentication 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","operationId":"OBPv1.2.1-getImagesForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["images"],"properties":{"images":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","id","date","user","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Image","description":"Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe image is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nlabel: My Account
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","operationId":"OBPv1.2.1-addImageForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"URL":{"type":"string"},"label":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL","id","date","user","label"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/webui_props":{"get":{"tags":["WebUi-Props"],"summary":"Get WebUiProps","description":"Get WebUiProps - properties that configure the Web UI behavior and appearance.
\nProperties with names starting with "webui_" can be stored in the database and managed via API.
\nData Sources:
\nExplicit WebUiProps (Database): Custom values created/updated via the API and stored in the database.
\nImplicit WebUiProps (Configuration File): Default values defined in the sample.props.template configuration file.
Query Parameter:
\nactive (optional, boolean string, default: "false")active=false or omitted: Returns only explicit props from the databaseactive=true: Returns explicit props + implicit (default) props from configuration file\nwebUiPropsId = "default"Examples:
\nGet only database-stored props:
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/management/webui_props
Get database props combined with defaults:
\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/management/webui_props?active=true
For more details about WebUI Props, including how to set config file defaults and precedence order, see here.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\n","operationId":"OBPv3.1.0-getWebUiProps","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["webui_props"],"properties":{"webui_props":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_ui_props_id","name","value"],"properties":{"web_ui_props_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"webui_props":{"type":"array","items":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["WebUi-Props"],"summary":"Create WebUiProps","description":"Create a WebUiProps.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExplaination of Fields:
\nThe line break and double quotations should do escape, example:
\n\n{"name": "webui_some", "value": "this value\nhave "line break" and double quotations."}\n\nshould do escape like this:
\n\n{"name": "webui_some", "value": "this value\\nhave \\"line break\\" and double quotations."}\n\nInsert image examples:
\n// set width=100 and height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}\n\n// only set height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}\n\n// only width=20%\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}\n\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\n","operationId":"OBPv3.1.0-createWebUiProps","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_ui_props_id","name","value"],"properties":{"web_ui_props_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/accounts/{accountid}/customer-account-links":{"get":{"tags":["Customer"],"summary":"Get Customer Account Links by ACCOUNT_ID","description":"Get Customer Account Links by ACCOUNT_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nlinks: links
\nrelationship_type: Owner
\n","operationId":"OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["links"],"properties":{"links":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_account_link_id","customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_account_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/accounts/account-routing-query":{"post":{"tags":["Account"],"summary":"Get Account by Account Routing","description":"This endpoint returns the account (if it exists) linked with the provided scheme and address.
\nThe bank_id field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.
Example of account routing scheme: IBAN, "OBP", "AccountNumber", ...
\nExample of account routing address: DE17500105178275645584, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\n\nscheme: OBP
\nbank_id: gh.29.uk
\nJSON response body fields:
\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-getAccountByAccountRouting","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_routing"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","tags","label","number","bank_id","owners","id","views_available","balance","account_attributes"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","value","date","user"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/cascading/banks/{bankid}":{"delete":{"tags":["Bank"],"summary":"Delete Bank Cascade","description":"Delete a Bank Cascade specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankCascade","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collection-ids/{apicollectionid}/api-collection-endpoints":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collection Endpoints By Id","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-getMyApiCollectionEndpointsById","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_endpoints"],"properties":{"api_collection_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Api-Collection"],"summary":"Create My Api Collection Endpoint By Id","description":"Create Api Collection Endpoint By Id.
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\noperation_id: OBPv6.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-createMyApiCollectionEndpointById","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/users/{userid}/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlement Requests for a User","description":"Get Entitlement Requests for a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.0.0-getEntitlementRequests","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_requests"],"properties":{"entitlement_requests":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_request_id","role_name","bank_id","user","created"],"properties":{"entitlement_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"created":{"type":"string","format":"date-time"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/accounts/{accountid}/standing-order":{"post":{"tags":["Standing-Order","Account"],"summary":"Create Standing Order (management)","description":"Create standing order for an account.
\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\n","operationId":"OBPv4.0.0-createStandingOrderManagement","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","counterparty_id","when","date_signed","amount","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["frequency","detail"],"properties":{"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"counterparty_id":{"type":"string"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"date_signed":{"type":"string","format":"date-time"},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","active","date_signed","bank_id","standing_order_id","date_cancelled","counterparty_id","when","amount","account_id","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"standing_order_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_cancelled":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["frequency","detail"],"properties":{"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"date_signed":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"standing_order_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/banks/{bankid}/cards/{cardid}":{"get":{"tags":["Card"],"summary":"Get Card By Id","description":"This will the datails of the card.
\nIt shows the account infomation which linked the the card.
\nAlso shows the card attributes of the card.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\ncancelled: false
\n\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_number: 1
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\nvalue: 5987953
\n\n","operationId":"OBPv3.1.0-getCardForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"cardid","in":"path","description":"The CARDID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["card_number","enabled","pin_reset","allows","collected","on_hot_list","card_type","replacement","name_on_card","expires_date","technology","posted","card_attributes","customer_id","bank_id","card_id","issue_number","account","serial_number","cancelled","valid_from_date","networks"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cancelled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","name","id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","attribute_type","bank_id","card_id","name","card_attribute_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type","enum"],"properties":{"type":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}}}},"card_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_hot_list":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"allows":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"name_on_card":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"technology":{"type":"string"},"posted":{"type":"string","format":"date-time"},"card_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"card_id":{"type":"string"},"name":{"type":"string"},"card_attribute_id":{"type":"string"}}}},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"card_id":{"type":"string"},"issue_number":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"}}},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"valid_from_date":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Card"],"summary":"Update Card","description":"Update Card at bank specified by CARD_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","operationId":"OBPv3.1.0-updatedCardForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"cardid","in":"path","description":"The CARDID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","allows","technology","collected","card_type","replacement","name_on_card","expires_date","posted","customer_id","pin_reset","networks","issue_number","serial_number","account_id","valid_from_date"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"collected":{"type":"string","format":"date-time"},"card_type":{"type":"string"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"name_on_card":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"account_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["card_number","enabled","pin_reset","allows","collected","on_hot_list","card_type","replacement","name_on_card","account","expires_date","technology","posted","customer_id","bank_id","card_id","issue_number","serial_number","cancelled","valid_from_date","networks"],"properties":{"allows":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"expires_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"networks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"replacement":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"collected":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cancelled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"pin_reset":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_requested","requested_date"],"properties":{"reason_requested":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requested_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"serial_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"valid_from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_hot_list":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"allows":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"technology":{"type":"string"},"posted":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"card_id":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"valid_from_date":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Card"],"summary":"Delete Card","description":"Delete a Card at bank specified by CARD_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteCardForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"cardid","in":"path","description":"The CARDID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/notes":{"put":{"tags":["ATM"],"summary":"Update ATM Notes","description":"Update ATM Notes.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nnotes: notes
\n","operationId":"OBPv4.0.0-updateAtmNotes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["notes"],"properties":{"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"notes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["notes","atm_id"],"properties":{"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"notes":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/connectors":{"get":{"tags":["Connector","System","API"],"summary":"Get Connectors","description":"Get the list of connectors and their availability for method routing.
\nReturns a sorted list of all connectors with their availability status for use in Method Routing.
\nconnector and starConnector_supported_types props settings.The OBP-API supports multiple connectors for accessing banking data:
\nUse this endpoint to discover which connectors are available when configuring Method Routing.
\nA connector is available for method routing if it matches the connector prop setting,
\nor if connector=star and the connector is listed in starConnector_supported_types.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetConnectorNames entitlement is required.
\nJSON response body fields:
\n\nconnectors: connectors
\nis_available_in_method_routing: is_available_in_method_routing
\n","operationId":"OBPv6.0.0-getConnectors","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connectors"],"properties":{"connectors":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_available_in_method_routing","connector_name"],"properties":{"is_available_in_method_routing":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"connectors":{"type":"array","items":{"type":"object","properties":{"is_available_in_method_routing":{"type":"boolean"},"connector_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/public_alias":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get public alias of other bank account","description":"Returns the public alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-getCounterpartyPublicAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update public alias of other bank account","description":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyPublicAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add public alias to other bank account","description":"Creates the public alias for the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication 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
\nthe 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyPublicAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Public Alias","description":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyPublicAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/connector/loopback":{"get":{"tags":["API","OAuth","OIDC"],"summary":"Get Connector Status (Loopback)","description":"This endpoint makes a call to the Connector to check the backend transport is reachable. (Deprecated)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\nduration_time: 60
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\n","operationId":"OBPv3.1.0-getObpConnectorLoopback","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_version","git_commit","duration_time"],"properties":{"connector_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"git_commit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"duration_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"connector_version":{"type":"string"},"git_commit":{"type":"string"},"duration_time":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transaction-requests/{transactionrequestid}/attribute":{"post":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Create Transaction Request Attribute","description":"Create Transaction Request Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON request body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createTransactionRequestAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attribute_type","name","value"],"properties":{"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","transaction_request_attribute_id","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_request_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/connector/metrics/counts":{"get":{"tags":["Metric","API"],"summary":"Get Connector Call Counts","description":"Returns per-hour Redis counters for connector outbound and inbound messages.
\nThis provides real-time visibility into which connector methods are being called
\nand how many responses (success/failure) are being received.
Counters automatically reset every hour (rolling window).
\nThe ttl_seconds field shows when the current hour window resets.
Requires the prop: write_connector_metrics_redis=true
\nRedis key format:
\nFor example: obp_dev_connector_outbound_1_star_getBanks_PER_HOUR
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nconnector_counts: connector_counts
\n\nenabled: false
\n\nper_hour_inbound_failure_count: per_hour_inbound_failure_count
\nper_hour_inbound_success_count: per_hour_inbound_success_count
\nper_hour_outbound_count: per_hour_outbound_count
\nttl_seconds: ttl_seconds
\n","operationId":"OBPv6.0.0-getConnectorCallCounts","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","connector_counts"],"properties":{"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"connector_counts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["per_hour_inbound_failure_count","method_name","ttl_seconds","connector_name","per_hour_outbound_count","per_hour_inbound_success_count"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"ttl_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_outbound_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_inbound_success_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_inbound_failure_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"connector_counts":{"type":"array","items":{"type":"object","properties":{"per_hour_inbound_failure_count":{"type":"integer"},"method_name":{"type":"string"},"ttl_seconds":{"type":"integer"},"connector_name":{"type":"string"},"per_hour_outbound_count":{"type":"integer"},"per_hour_inbound_success_count":{"type":"integer"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.2.0/management/connector/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Connector Metrics","description":"Get the all metrics
\nrequire CanGetConnectorMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 1000) eg:limit=2000
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300
\nOther filters:
\n5 connector_name (if null ignore)
\n6 function_name (if null ignore)
\n7 correlation_id (if null ignore)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nduration: 5.123
\n\n\n","operationId":"OBPv2.2.0-getConnectorMetrics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_name","duration","date","correlation_id","function_name"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"correlation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"connector_name":{"type":"string"},"duration":{"type":"integer"},"date":{"type":"string","format":"date-time"},"correlation_id":{"type":"string"},"function_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/consumer/consent-requests/{consentrequestid}":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consent Request","description":"User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","operationId":"OBPv5.0.0-getConsentRequest","parameters":[{"name":"consentrequestid","in":"path","description":"The CONSENTREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumer_id","consent_request_id","payload"],"properties":{"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["phone_number","everything","account_access","valid_from","time_to_live"],"properties":{"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routing","view_id"],"properties":{"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"payload":{"type":"object","properties":{"phone_number":{"type":"string"},"everything":{"type":"boolean"},"account_access":{"type":"array","items":{"type":"object","properties":{"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"view_id":{"type":"string"}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/my/dynamic-entities/{dynamicentityid}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete My Dynamic Entity","description":"Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nFor more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteMyDynamicEntity","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/account-applications":{"get":{"tags":["Account-Application","Account"],"summary":"Get Account Applications","description":"Get the Account Applications.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","operationId":"OBPv3.1.0-getAccountApplications","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_applications"],"properties":{"account_applications":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","product_code","status","customer","date_of_application","account_application_id"],"properties":{"date_of_application":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"account_application_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"account_applications":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"date_of_application":{"type":"string","format":"date-time"},"account_application_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Account-Application","Account"],"summary":"Create Account Application","description":"Create Account Application
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nproduct_code: 1234BW
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","operationId":"OBPv3.1.0-createAccountApplication","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","product_code","customer_id"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"product_code":{"type":"string"},"customer_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","product_code","status","customer","date_of_application","account_application_id"],"properties":{"date_of_application":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"account_application_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"date_of_application":{"type":"string","format":"date-time"},"account_application_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/endpoints/{operationid}/tags/{endpointtagid}":{"put":{"tags":["API"],"summary":"Update Bank Level Endpoint Tag","description":"Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\ntag_name: BankAccountTag1
\n","operationId":"OBPv4.0.0-updateBankLevelEndpointTag","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointtagid","in":"path","description":"The ENDPOINTTAGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tag_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","tag_name","bank_id","endpoint_tag_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tag_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"endpoint_tag_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["API"],"summary":"Delete Bank Level Endpoint Tag","description":"Delete Bank Level Endpoint Tag.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv6.0.0-getBanks
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankLevelEndpointTag","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"operationid","in":"path","description":"The OPERATIONID identifier","required":true,"schema":{"type":"string"}},{"name":"endpointtagid","in":"path","description":"The ENDPOINTTAGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user-invitation":{"post":{"tags":["User-Invitation","KYC"],"summary":"Create User Invitation","description":"Create User Invitation.
\nThis endpoint will send an invitation email to the developers, then they can use the link to create the obp user.
\npurpose filed only support:List(DEVELOPER, CUSTOMER).
\nYou can customise the email details use the following webui props:
\nwhen purpose == DEVELOPER
\nwebui_developer_user_invitation_email_subject
\nwebui_developer_user_invitation_email_from
\nwebui_developer_user_invitation_email_text
\nwebui_developer_user_invitation_email_html_text
when purpose = == CUSTOMER
\nwebui_customer_user_invitation_email_subject
\nwebui_customer_user_invitation_email_from
\nwebui_customer_user_invitation_email_text
\nwebui_customer_user_invitation_email_html_text
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","operationId":"OBPv4.0.0-createUserInvitation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","purpose","first_name","country","company","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","purpose","first_name","country","status","company","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/accounts/{accountid}/permissions":{"get":{"tags":["View-Custom","Account","User","Entitlement"],"summary":"Get access","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nand the user needs to have access to the owner view.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nprovider: ETHEREUM
\n\nuser:
\n\n","operationId":"OBPv2.0.0-getPermissionsForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views","user"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_see_bank_account_swift_bic","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_comment","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_see_physical_location","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_balance","can_add_public_alias","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","can_see_transaction_metadata","id","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_delete_image","can_add_tag","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name","alias"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{refund}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (REFUND)","description":"Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.
In case the from object is used, it means that the refund comes from the part that sent you a transaction.
\nIn the from object, you have two choices :
\n- Use bank_id and account_id fields if the other account is registered on the OBP-API
\n- Use the counterparty_id field in case the counterparty account is out of the OBP-API
In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
\n(This case is not managed by the OBP-API and require an external adapter)
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nREFUND: REFUND
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nreason_code: reason_code
\nrefund: refund
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfrom:
\nto:
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestRefund","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"refund","in":"path","description":"The REFUND identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","to","from","refund","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"refund":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["reason_code","transaction_id"],"properties":{"reason_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id","counterparty_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"from":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"refund":{"type":"object","properties":{"reason_code":{"type":"string"},"transaction_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/tax-residences":{"get":{"tags":["Customer","KYC"],"summary":"Get Tax Residences of Customer","description":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ntax_number: 456
\n\n\n","operationId":"OBPv3.1.0-getTaxResidence","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tax_residence"],"properties":{"tax_residence":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tax_number","domain","tax_residence_id"],"properties":{"tax_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"domain":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tax_residence_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"tax_residence":{"type":"array","items":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules":{"get":{"tags":["ABAC"],"summary":"Get ABAC Rules","description":"Get all ABAC rules.
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\nabac_rules: abac_rules
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nupdated_by_user_id: updated_by_user_id
\n","operationId":"OBPv6.0.0-getAbacRules","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["abac_rules"],"properties":{"abac_rules":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","abac_rule_id","is_active","updated_by_user_id","created_by_user_id","description","rule_code","rule_name"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_by_user_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"abac_rules":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string"},"abac_rule_id":{"type":"string"},"is_active":{"type":"boolean"},"updated_by_user_id":{"type":"string","format":"date-time"},"created_by_user_id":{"type":"string"},"description":{"type":"string"},"rule_code":{"type":"string"},"rule_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["ABAC"],"summary":"Create ABAC Rule","description":"Create a new ABAC (Attribute-Based Access Control) rule.
\nABAC rules are Scala functions that return a Boolean value indicating whether access should be granted.
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
\n- here - Testing examples and patterns
The rule function receives 18 parameters including authenticatedUser, attributes, auth context, and optional objects (bank, account, transaction, etc.).
\nExample rule code:
\n// Allow access only if authenticated user is admin\nauthenticatedUser.emailAddress.contains("admin")\n// Allow access only to accounts with balance > 1000\naccountOpt.exists(_.balance.toDouble > 1000.0)\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nJSON response body fields:
\nabac_rule_id: abac_rule_id
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\npolicy: policy
\nrule_code: rule_code
\nrule_name: rule_name
\nupdated_by_user_id: updated_by_user_id
\n","operationId":"OBPv6.0.0-createAbacRule","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","is_active","description","rule_code","rule_name"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"policy":{"type":"string"},"is_active":{"type":"boolean"},"description":{"type":"string"},"rule_code":{"type":"string"},"rule_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["policy","abac_rule_id","is_active","updated_by_user_id","created_by_user_id","description","rule_code","rule_name"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_by_user_id":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"abac_rule_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"policy":{"type":"string"},"abac_rule_id":{"type":"string"},"is_active":{"type":"boolean"},"updated_by_user_id":{"type":"string","format":"date-time"},"created_by_user_id":{"type":"string"},"description":{"type":"string"},"rule_code":{"type":"string"},"rule_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/customers/{customerid}/kyc_documents":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Documents","description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
\nGet a list of documents that affirm the identity of the customer
\nPassport, driving licence etc.
\nUser 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.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","operationId":"OBPv2.0.0-getKycDocuments","parameters":[{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["documents"],"properties":{"documents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["expiry_date","issue_place","customer_id","type","issue_date","number","bank_id","customer_number","id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issue_place":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"expiry_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/signal/channels/stats":{"get":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"Get Signal Channel Stats","description":"Returns statistics for all signal channels, including private-only channels.
\nUnlike the List Signal Channels endpoint, this does not filter out private-only channels.
\nIt provides a complete view of all active channels with message counts and TTL info.
Authentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nchannel_name: channel_name
\nchannels: channels
\nmessage_count: message_count
\ntotal_channels: total_channels
\ntotal_messages: total_messages
\nttl_seconds: ttl_seconds
\n","operationId":"OBPv6.0.0-getSignalStats","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["total_channels","channels","total_messages"],"properties":{"total_channels":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channels":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["ttl_seconds","message_count","channel_name"],"properties":{"ttl_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"total_messages":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"total_channels":{"type":"integer"},"channels":{"type":"array","items":{"type":"object","properties":{"ttl_seconds":{"type":"integer"},"message_count":{"type":"integer"},"channel_name":{"type":"string"}}}},"total_messages":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/account-directory":{"get":{"tags":["Account"],"summary":"Get Account Directory at Bank","description":"Returns a list of accounts at the bank with identifiers and metadata.
\nThis endpoint is designed for management UIs that need to list accounts
\nwithout exposing sensitive data (balance and owners are excluded).
The response includes: account_id, bank_id, label, account_number, account_type, branch_id,
\naccount_routings, account_attributes and view_ids.
Possible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\naccount_number: 546387432
\n\naccount_type: AC
\n\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncode: 125
\nlabel: My Account
\ntype:
\nvalue: 5987953
\nview_ids: view_ids
\n","operationId":"OBPv6.0.0-getAccountDirectory","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","branch_id","bank_id","label","account_type","account_number","account_attributes","view_ids","account_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","code","value"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}}},"branch_id":{"type":"string"},"bank_id":{"type":"string"},"label":{"type":"string"},"account_type":{"type":"string"},"account_number":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"code":{"type":"string"},"value":{"type":"string"}}}},"view_ids":{"type":"array","items":{"type":"string"}},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts":{"get":{"tags":["Account","PrivateData","PublicData"],"summary":"Get Accounts at Bank","description":"Returns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user.
\nEach account must have at least one private View.
This v6.0.0 version returns account_id instead of id for consistency with other v6.0.0 endpoints.
Optional request parameters for filtering with attributes:
\nURL params example: /banks/some-bank-id/accounts?limit=50&offset=1
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","operationId":"OBPv6.0.0-getAccountsAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","views_available","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views_available":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","is_public","id"],"properties":{"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"is_public":{"type":"boolean"},"id":{"type":"string"}}}},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/email/{email}/terminator":{"get":{"tags":["User"],"summary":"Get Users by Email Address","description":"Get users by email address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
URL Parameters:
\n\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","operationId":"OBPv4.0.0-getUsersByEmail","parameters":[{"name":"email","in":"path","description":"The EMAIL identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["users"],"properties":{"users":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","last_marketing_agreement_signed_date","provider_id","agreements","entitlements","is_deleted","is_locked","username","views","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"is_locked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"last_marketing_agreement_signed_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"agreements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","text"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/banks/{bankid}/dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get Bank Level Dynamic Entities","description":"Get all Bank Level Dynamic Entities for one bank with record counts.
\nEach dynamic entity in the response includes a record_count field showing how many data records exist for that entity.
This v6.0.0 endpoint returns snake_case field names and an explicit entity_name field.
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-getBankLevelDynamicEntities","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","record_count","bank_id","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"record_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"type":{"type":"string"}}},"language":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"record_count":{"type":"integer"},"bank_id":{"type":"string"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Create Bank Level Dynamic Entity","description":"Create a bank level Dynamic Entity.
\nThis v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.
Request format:
\n{\n "entity_name": "customer_preferences",\n "has_personal_entity": true,\n "has_public_access": false,\n "has_community_access": false,\n "personal_requires_role": false,\n "schema": {\n "description": "User preferences",\n "required": ["theme"],\n "properties": {\n "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference"},\n "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"}\n }\n }\n}\nNote:
\n* The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
\n* Each property MUST include an example field with a valid example value.
\n* Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
\n* Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
\n* Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
\n* Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-createBankLevelDynamicEntity","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["has_community_access","schema","has_personal_entity","personal_requires_role","entity_name","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"has_community_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}}}}}},"has_personal_entity":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_public_access":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entity_id","has_community_access","schema","bank_id","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}}}}}},"bank_id":{"type":"string"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system/log-cache/warning":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Warning Level Log Cache","description":"Returns WARNING level logs from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/warning?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheWarningEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/tax_residencies/{taxresidenceid}":{"delete":{"tags":["Customer","KYC"],"summary":"Delete Tax Residence","description":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteTaxResidence","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"taxresidenceid","in":"path","description":"The TAXRESIDENCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/development/echo/jws-verified-request-jws-signed-response":{"get":{"tags":["API"],"summary":"Verify Request and Sign Response of a current call","description":"Verify Request and Sign Response of a current call.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-verifyRequestSignResponse","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/webui-props":{"get":{"tags":["WebUi-Props"],"summary":"Get WebUiProps","description":"Get WebUiProps - properties that configure the Web UI behavior and appearance.
\nProperties with names starting with "webui_" can be stored in the database and managed via API.
\nData Sources:
\nExplicit WebUiProps (Database): Custom values created/updated via the API and stored in the database.
\nImplicit WebUiProps (Configuration File): Default values defined in the sample.props.template configuration file.
Response Fields:
\nname: The property namevalue: The property valuewebUiPropsId (optional): UUID for database props, omitted for config propssource: Either "database" (editable via API) or "config" (read-only from config file)Query Parameter:
\nwhat (optional, string, default: "active")active: Returns one value per property name\ndatabase: Returns ONLY properties explicitly stored in the database (source="database")config: Returns ONLY default properties from configuration file (source="config")Examples:
\nGet active props (database overrides config, one value per prop):
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props?what=active
Get only database-stored props:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props?what=database
Get only default props from configuration:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props?what=config
For more details about WebUI Props, including how to set config file defaults and precedence order, see here.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\n","operationId":"OBPv6.0.0-getWebUiProps","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["webui_props"],"properties":{"webui_props":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_ui_props_id","name","value","source"],"properties":{"web_ui_props_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"webui_props":{"type":"array","items":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"source":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/account-access-requests":{"get":{"tags":["Account-Access-Request"],"summary":"Get Account Access Requests for Account","description":"Get Account Access Requests for a specific account (checker view).
\nOptionally filter by status using the query parameter: ?status=INITIATED
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_access_requests: account_access_requests
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-getAccountAccessRequestsForAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access_requests"],"properties":{"account_access_requests":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","created","account_access_request_id","is_system_view","business_justification","bank_id","view_id","target_user_id","checker_user_id","status","updated","account_id","checker_comment"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"account_access_requests":{"type":"array","items":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"status":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"checker_comment":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Account-Access-Request"],"summary":"Create Account Access Request","description":"Create a new Account Access Request (maker step in maker/checker workflow).
\nThe requestor (maker) creates a request to grant a target user access to a specific view on an account.
\nA business justification is required.
The request is created with status INITIATED and must be approved or rejected by a different user (checker).
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nbusiness_justification: business_justification
\nis_system_view: is_system_view
\ntarget_user_id: target_user_id
\nview_id: owner
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-createAccountAccessRequest","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_system_view","business_justification","view_id","target_user_id"],"properties":{"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","created","account_access_request_id","is_system_view","business_justification","bank_id","view_id","target_user_id","checker_user_id","status","updated","account_id","checker_comment"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"status":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"checker_comment":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/counterparties/{counterpartyid}/limits":{"get":{"tags":["Counterparty-Limits"],"summary":"Get Counterparty Limit","description":"Get Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","operationId":"OBPv5.1.0-getCounterpartyLimit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","bank_id","counterparty_id","counterparty_limit_id","view_id","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","account_id","max_yearly_amount","max_number_of_transactions"],"properties":{"counterparty_limit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Counterparty-Limits"],"summary":"Update Counterparty Limit","description":"Update Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","operationId":"OBPv5.1.0-updateCounterpartyLimit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","max_yearly_amount","max_number_of_transactions"],"properties":{"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","bank_id","counterparty_id","counterparty_limit_id","view_id","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","account_id","max_yearly_amount","max_number_of_transactions"],"properties":{"counterparty_limit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Limits"],"summary":"Create Counterparty Limit","description":"Create limits (for single or recurring payments) for a counterparty specified by the COUNTERPARTY_ID.
\nUsing this endpoint, we can attach a limit record to a Counterparty referenced by its counterparty_id (a UUID).
\nFor more information on Counterparty Limits, see here
\nFor an introduction to Counterparties in OBP, see here
\nYou can automate the process of creating counterparty limits and consents for VRP with this endpoint.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON request body fields:
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","operationId":"OBPv5.1.0-createCounterpartyLimit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","max_yearly_amount","max_number_of_transactions"],"properties":{"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["max_total_amount","currency","bank_id","counterparty_id","counterparty_limit_id","view_id","max_number_of_yearly_transactions","max_monthly_amount","max_single_amount","max_number_of_monthly_transactions","account_id","max_yearly_amount","max_number_of_transactions"],"properties":{"counterparty_limit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_monthly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_monthly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_single_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_yearly_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"max_total_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Limits"],"summary":"Delete Counterparty Limit","description":"Delete Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteCounterpartyLimit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/accounts/{accountid}/{viewid}/counterparty-names/{counterpartyname}":{"get":{"tags":["Counterparty","Account"],"summary":"Get Counterparty by name for any account (Explicit) ","description":"This is a management endpoint that allows the retrieval of any Counterparty on an Account / View by its Name.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_NAME: John Smith Ltd.
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getCounterpartyByNameForAnyAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyname","in":"path","description":"The COUNTERPARTYNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","metadata","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["private_alias","physical_location","url","public_alias","open_corporates_url","more_info","corporate_location","image_url"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/my/consents/{sms}":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent (SMS)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"email": "eveline@example.com"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomersAtOneBank"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\nSMS:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv3.1.0-createConsentSms","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"sms","in":"path","description":"The SMS identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlements","phone_number","everything","valid_from","views","consumer_id","time_to_live"],"properties":{"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"phone_number":{"type":"string"},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consent_id","status","jwt"],"properties":{"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/api-collections/featured":{"get":{"tags":["Api-Collection","API"],"summary":"Get Featured Api Collections (Admin)","description":"Get all featured API collections with their sort order (admin view).
\nThis endpoint returns the featured collections stored in the database with their sort order.
\nIt is intended for administrators to manage the featured list.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfeatured_api_collection_id: 9uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfeatured_api_collections: featured_api_collections
\nsort_order: 1
\n","operationId":"OBPv6.0.0-getFeaturedApiCollectionsAdmin","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["featured_api_collections"],"properties":{"featured_api_collections":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["featured_api_collection_id","api_collection_id","sort_order"],"properties":{"featured_api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sort_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"featured_api_collections":{"type":"array","items":{"type":"object","properties":{"featured_api_collection_id":{"type":"string"},"api_collection_id":{"type":"string"},"sort_order":{"type":"integer"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Api-Collection","API"],"summary":"Create Featured Api Collection","description":"Add an API Collection to the featured list.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nsort_order: 1
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfeatured_api_collection_id: 9uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nsort_order: 1
\n","operationId":"OBPv6.0.0-createFeaturedApiCollection","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","sort_order"],"properties":{"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sort_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"sort_order":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["featured_api_collection_id","api_collection_id","sort_order"],"properties":{"featured_api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sort_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"featured_api_collection_id":{"type":"string"},"api_collection_id":{"type":"string"},"sort_order":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"},"401":{"description":"Unauthorized"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/customers/{customerid}/kyc_statuses":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Status","description":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n","operationId":"OBPv2.0.0-addKycStatus","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number","date","ok"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"ok":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","customer_number","date","ok"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"ok":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/webui_props/{webuipropsid}":{"delete":{"tags":["WebUi-Props"],"summary":"Delete WebUiProps","description":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteWebUiProps","parameters":[{"name":"webuipropsid","in":"path","description":"The WEBUIPROPSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}":{"get":{"tags":["Product"],"summary":"Get Bank Product","description":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:
\nThe combination of bank_id and product_code is unique.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrequency: DAILY
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n\nmeta:
\nmore_info: More information about this fee
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nfees: fees
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\n","operationId":"OBPv4.0.0-getProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","bank_id","meta","attributes","more_info_url","parent_product_code","description","name","terms_and_conditions_url","fees"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","product_attribute_id","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"fees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_active","name","more_info","value","product_fee_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_fee_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.0.0/banks":{"put":{"tags":["Bank"],"summary":"Update Bank","description":"Update an existing bank (Authenticated access).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv5.0.0-updateBank","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["full_name","logo","id","bank_code","website","bank_routings"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"full_name":{"type":"string"},"logo":{"type":"string"},"id":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routings","website","attributes","logo","bank_code","full_name","id"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/endpoint-mappings":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get all Bank Level Endpoint Mappings","description":"Get all Bank Level Endpoint Mappings.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-getAllBankLevelEndpointMappings","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["endpoint-mappings"],"properties":{"endpoint-mappings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Endpoint-Mapping"],"summary":"Create Bank Level Endpoint Mapping","description":"Create an Bank Level Endpoint Mapping.
\nNote: at moment only support the dynamic endpoints
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-createBankLevelEndpointMapping","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/products/{productcode}":{"put":{"tags":["Product"],"summary":"Create Product","description":"Create or Update Product for the Bank.
\nThe combination of bank_id and product_code is unique. If a Product already exists for the bank_id and product_code, it will be updated.
\nTypical Super Family values / Asset classes are:
\nDebt
\nEquity
\nFX
\nCommodity
\nDerivative
Product hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","operationId":"OBPv5.0.0-createProduct","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","more_info_url","terms_and_conditions_url","parent_product_code","meta","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"more_info_url":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"parent_product_code":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","bank_id","meta","more_info_url","parent_product_code","description","name","terms_and_conditions_url"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users":{"get":{"tags":["User"],"summary":"Get all Users","description":"Get all users
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\nrecent_operation_ids: recent_operation_ids
\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nview_id: owner
\nagreements: agreements
\nlast_activity_date: last_activity_date
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","operationId":"OBPv6.0.0-getUsers","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["users"],"properties":{"users":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","last_marketing_agreement_signed_date","provider_id","agreements","entitlements","recent_operation_ids","last_activity_date","is_deleted","is_locked","username","views","user_id"],"properties":{"last_activity_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"recent_operation_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"is_locked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"last_marketing_agreement_signed_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"agreements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","text"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"recent_operation_ids":{"type":"array","items":{"type":"string"}},"last_activity_date":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["User","Onboarding"],"summary":"Create User (v6.0.0)","description":"Creates OBP user.
\nNo authorisation required.
Mimics current webform to Register.
\nRequires username(email), password, first_name, last_name, and email.
\nValidation checks performed:
\n- Password must meet strong password requirements (InvalidStrongPasswordFormat error if not)
\n- Username must be unique (409 error if username already exists)
\n- All required fields must be present in valid JSON format
Email validation behavior:
\n- Controlled by property 'authUser.skipEmailValidation' (default: false)
\n- When false: User is created with validated=false and a validation email is sent to the user's email address
\n- The validation link is constructed using the portal_external_url property which must be set
\n- When true: User is created with validated=true and no validation email is sent
\n- Default entitlements are granted immediately regardless of validation status
Note: If email validation is required (skipEmailValidation=false), the user must click the validation link
\nin the email before they can log in, even though entitlements are already granted.
User Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\nfirst_name: Tom
\nlast_name: Smith
\npassword: password
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv6.0.0-createUser","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","first_name","password","username","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"password":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"last_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/management/connector-methods":{"get":{"tags":["Connector-Method"],"summary":"Get all Connector Methods","description":"Get all Connector Methods.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getAllConnectorMethods","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connectors_methods"],"properties":{"connectors_methods":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_method_id","method_name","programming_lang","method_body"],"properties":{"connector_method_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"connectors_methods":{"type":"array","items":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Connector-Method"],"summary":"Create Connector Method","description":"Create an internal connector.
\nThe method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-createConnectorMethod","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["method_name","programming_lang","method_body"],"properties":{"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_method_id","method_name","programming_lang","method_body"],"properties":{"connector_method_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/CovidAPIDays":{"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays List","description":"Get CovidAPIDays List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"CovidAPIDays"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /CovidAPIDays?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new CovidAPIDays.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"CovidAPIDays"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createCovidAPIDays_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days"],"properties":{"covid_api_days":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["covid_api_days_id","name","number"],"properties":{"covid_api_days_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/product-collections/{collectioncode}":{"get":{"tags":["Product-Collection","Product"],"summary":"Get Product Collection","description":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\n\n\ntype:
\nvalue: 5987953
\n\n","operationId":"OBPv3.1.0-getProductCollection","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"collectioncode","in":"path","description":"The COLLECTIONCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["products","collection_code"],"properties":{"products":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["super_family","description","details","parent_product_code","bank_id","code","more_info_url","meta","family","product_attributes","name","category"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"super_family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","product_attribute_id","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"details":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"collection_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"name":{"type":"string"},"category":{"type":"string"}}}},"collection_code":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Product-Collection","Product"],"summary":"Create Product Collection","description":"Create or Update a Product Collection at the Bank.
\nUse Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
\nThere is a many to many relationship between Products and Product Collections:
\nA Product can exist in many Collections
\nA Collection can contain many Products.
\nA collection has collection code, one parent Product and one or more child Products.
\nProduct hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n\n\n\nproduct_code: 1234BW
\n\n","operationId":"OBPv3.1.0-createProductCollection","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"collectioncode","in":"path","description":"The COLLECTIONCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["parent_product_code","children_product_codes"],"properties":{"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"children_product_codes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"parent_product_code":{"type":"string"},"children_product_codes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_collection"],"properties":{"product_collection":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["collection_code","product_code","items"],"properties":{"collection_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"items":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["member_product_code"],"properties":{"member_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"product_collection":{"type":"array","items":{"type":"object","properties":{"collection_code":{"type":"string"},"product_code":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"member_product_code":{"type":"string"}}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/private_alias":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Private Alias","description":"Returns the private alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-getOtherAccountPrivateAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Private Alias","description":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyPrivateAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Create Other Account Private Alias","description":"Creates a private alias for the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addOtherAccountPrivateAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alias"],"properties":{"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Private Alias","description":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyPrivateAlias","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/system/integrity/system-view-names-check":{"get":{"tags":["System-Integrity"],"summary":"Check System View Names","description":"Check system view names.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","operationId":"OBPv5.1.0-systemViewNamesCheck","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/{accountid}/views":{"post":{"tags":["View-Custom","Account"],"summary":"Create Custom View","description":"Create a custom view on bank account
\nUser 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.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe '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.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv3.0.0-createViewForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hide_metadata_if_alias_used","name","description","is_public","metadata_view","which_alias_to_use","allowed_actions"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/connector-methods/{connectormethodid}":{"get":{"tags":["Connector-Method"],"summary":"Get Connector Method by Id","description":"Get an internal connector by CONNECTOR_METHOD_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-getConnectorMethod","parameters":[{"name":"connectormethodid","in":"path","description":"The CONNECTORMETHODID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_method_id","method_name","programming_lang","method_body"],"properties":{"connector_method_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Connector-Method"],"summary":"Update Connector Method","description":"Update an internal connector.
\nThe method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-updateConnectorMethod","parameters":[{"name":"connectormethodid","in":"path","description":"The CONNECTORMETHODID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["programming_lang","method_body"],"properties":{"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["connector_method_id","method_name","programming_lang","method_body"],"properties":{"connector_method_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/consumers/{consumerid}/consumer/logo_url":{"put":{"tags":["Consumer"],"summary":"Update Consumer LogoURL","description":"Update an existing logoURL for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-updateConsumerLogoURL","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["logo_url"],"properties":{"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"logo_url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/api-collections/{apicollectionid}/api-collection-endpoints":{"get":{"tags":["Api-Collection"],"summary":"Get Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv6.0.0-getBanks
\n","operationId":"OBPv4.0.0-getApiCollectionEndpoints","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_endpoints"],"properties":{"api_collection_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","api_collection_id","api_collection_endpoint_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/users/user-id/{userid}":{"get":{"tags":["User"],"summary":"Get User by USER_ID","description":"Get user by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\nrecent_operation_ids: recent_operation_ids
\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\nagreements: agreements
\nlast_activity_date: last_activity_date
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","operationId":"OBPv6.0.0-getUserByUserId","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","last_marketing_agreement_signed_date","provider_id","agreements","entitlements","recent_operation_ids","last_activity_date","is_deleted","is_locked","username","views","user_id"],"properties":{"last_activity_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"recent_operation_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"is_locked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"last_marketing_agreement_signed_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"agreements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","text"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"recent_operation_ids":{"type":"array","items":{"type":"string"}},"last_activity_date":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/attributes/{customerattributeid}":{"put":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Update Customer Attribute","description":"Update Customer Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-updateCustomerAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"customerattributeid","in":"path","description":"The CUSTOMERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/aggregate-metrics":{"get":{"tags":["Metric","Aggregate-Metrics"],"summary":"Get Aggregate Metrics","description":"Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.
\nrequire CanReadAggregateMetrics role
\nNOTE: Automatic from_date Default
\nIf you do not provide a from_date parameter, this endpoint will automatically set it to:
\nnow - 9 minutes ago
This prevents accidentally querying all metrics since Unix Epoch and ensures reasonable response times.
\nFor historical/reporting queries, always explicitly specify your desired from_date.
IMPORTANT: Smart Caching & Performance
\nThis endpoint uses intelligent two-tier caching to optimize performance:
\nStable Data Cache (Long TTL):
\n- Metrics older than 600 seconds (10 minutes) are considered immutable/stable
\n- These are cached for 86400 seconds (24 hours)
\n- Used when your query's from_date is older than the stable boundary
Recent Data Cache (Short TTL):
\n- Recent metrics (within the stable boundary) are cached for 7 seconds
\n- Used when your query includes recent data or has no from_date
Why from_date matters:
\n- Queries WITH from_date older than 10 mins → cached for 24 hours (fast!)
\n- Queries WITHOUT from_date → cached for only 7 seconds (slower)
Should be able to filter on the following fields
\neg: /management/aggregate-metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&include_app_names=API-EXPLORER,API-Manager,SOFI,null&http_status_code=200
IMPORTANT: v6.0.0+ Breaking Change
\nThis version does NOT support the old exclude_* parameters:
\n- exclude_app_names - NOT supported (returns error)
\n- exclude_url_patterns - NOT supported (returns error)
\n- exclude_implemented_by_partial_functions - NOT supported (returns error)
Use include_* parameters instead (all optional):
\n- include_app_names - Optional - include only these apps
\n- include_url_patterns - Optional - include only URLs matching these patterns
\n- include_implemented_by_partial_functions - Optional - include only these functions
1 from_date e.g.:from_date=1100-01-01T01:01:01.000Z
\nDEFAULT: If not provided, automatically set to now - 9 minutes (keeps queries in recent data zone)
\nIMPORTANT: Including from_date enables long-term caching for historical data queries!
2 to_date (defaults to the current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore)
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 include_app_names (if null ignore).eg: &include_app_names=API-EXPLORER,API-Manager,SOFI,null
\n13 include_url_patterns (if null ignore).you can design you own SQL LIKE pattern. eg: &include_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n14 include_implemented_by_partial_functions (if null ignore).eg: &include_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\n15 http_status_code (if null ignore) - Filter by HTTP status code. eg: http_status_code=200 returns only successful calls, http_status_code=500 returns server errors
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\n\n\n\n","operationId":"OBPv6.0.0-getAggregateMetrics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["count","average_response_time","maximum_response_time","minimum_response_time"],"properties":{"count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"average_response_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maximum_response_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_response_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"count":{"type":"integer"},"average_response_time":{"type":"number"},"maximum_response_time":{"type":"number"},"minimum_response_time":{"type":"number"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/personal-data-fields/{userattributeid}":{"get":{"tags":["User","User-Attribute","Attribute"],"summary":"Get Personal Data Field By Id","description":"Get a Personal Data Field by USER_ATTRIBUTE_ID for the currently authenticated user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-getPersonalDataFieldById","parameters":[{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["User","User-Attribute","Attribute"],"summary":"Update Personal Data Field","description":"Update a Personal Data Field by USER_ATTRIBUTE_ID for the currently authenticated user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-updatePersonalDataField","parameters":[{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","name","type"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insert_date","value","user_attribute_id","type","is_personal","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_personal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"insert_date":{"type":"string","format":"date-time"},"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["User","User-Attribute","Attribute"],"summary":"Delete Personal Data Field","description":"Delete a Personal Data Field by USER_ATTRIBUTE_ID for the currently authenticated user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deletePersonalDataField","parameters":[{"name":"userattributeid","in":"path","description":"The USERATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/customer_cars/{customercarsid}":{"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars by id","description":"Get customer_cars by id.
\nThe car the customer arrived in
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"customer_cars"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSinglecustomer_cars_","parameters":[{"name":"customercarsid","in":"path","description":"The CUSTOMERCARSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars"],"properties":{"customer_cars":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars_id","customer_identifier","manufacturer"],"properties":{"customer_cars_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Update customer_cars","description":"Update customer_cars.
\nThe car the customer arrived in
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"customer_cars"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updatecustomer_cars_","parameters":[{"name":"customercarsid","in":"path","description":"The CUSTOMERCARSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_identifier","manufacturer"],"properties":{"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars"],"properties":{"customer_cars":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars_id","customer_identifier","manufacturer"],"properties":{"customer_cars_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Delete customer_cars by id","description":"Delete customer_cars by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"customer_cars"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deletecustomer_cars_","parameters":[{"name":"customercarsid","in":"path","description":"The CUSTOMERCARSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars"],"properties":{"customer_cars":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_cars_id","customer_identifier","manufacturer"],"properties":{"customer_cars_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"manufacturer":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string"},"customer_identifier":{"type":"string"},"manufacturer":{"type":"string"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/users/{userid}/auth-context/{userauthcontextid}":{"delete":{"tags":["User"],"summary":"Delete User Auth Context","description":"Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteUserAuthContextById","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}},{"name":"userauthcontextid","in":"path","description":"The USERAUTHCONTEXTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/current/user_id":{"get":{"tags":["User"],"summary":"Get User Id (Current)","description":"Get the USER_ID of the logged in user
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getCurrentUserId","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/FooBar/{foobarid}":{"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar by id","description":"Get FooBar by id.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FooBar"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleFooBar_","parameters":[{"name":"foobarid","in":"path","description":"The FOOBARID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar"],"properties":{"foo_bar":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar_id","name","number"],"properties":{"foo_bar_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Update FooBar","description":"Update FooBar.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FooBar"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateFooBar_","parameters":[{"name":"foobarid","in":"path","description":"The FOOBARID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar"],"properties":{"foo_bar":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar_id","name","number"],"properties":{"foo_bar_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Delete FooBar by id","description":"Delete FooBar by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"FooBar"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteFooBar_","parameters":[{"name":"foobarid","in":"path","description":"The FOOBARID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar"],"properties":{"foo_bar":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["foo_bar_id","name","number"],"properties":{"foo_bar_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2"],"summary":"Get Bank","description":"Get the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_id: gh.29.uk
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv6.0.0-getBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routings","website","logo","bank_id","attributes","bank_code","full_name"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"logo":{"type":"string"},"bank_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_code":{"type":"string"},"full_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v2.1.0/roles":{"get":{"tags":["Role"],"summary":"Get Roles","description":"Returns all available roles
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\nrole:
\nroles: CanCreateMyUser
\n","operationId":"OBPv2.1.0-getRoles","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles"],"properties":{"roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role","requires_bank_id"],"properties":{"role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requires_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/well-known":{"get":{"tags":["API"],"summary":"Get Well Known URIs","description":"Get the OAuth2 server's public Well Known URIs.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\n\n","operationId":"OBPv5.1.0-getOAuth2ServerWellKnown","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jwks_uris"],"properties":{"jwks_uris":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jwks_uri"],"properties":{"jwks_uri":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"jwks_uris":{"type":"array","items":{"type":"object","properties":{"jwks_uri":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/banks/{bankid}/atms/{atmid}":{"get":{"tags":["ATM"],"summary":"Get Bank ATM","description":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","operationId":"OBPv5.1.0-getAtm","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","attributes","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["ATM"],"summary":"UPDATE ATM","description":"Update ATM.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","operationId":"OBPv5.1.0-updateAtm","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","attributes","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["ATM"],"summary":"Delete ATM","description":"Delete ATM.
\nThis will also delete all its attributes.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteAtm","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/balances/{balanceid}":{"get":{"tags":["Account","Balance"],"summary":"Get Bank Account Balance By ID","description":"Get a specific Bank Account Balance by its BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","operationId":"OBPv5.1.0-getBankAccountBalanceById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"balanceid","in":"path","description":"The BALANCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","bank_id","balance_id","account_id","balance_type"],"properties":{"balance_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Account","Balance"],"summary":"Update Bank Account Balance","description":"Update an existing Bank Account Balance specified by BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","operationId":"OBPv5.1.0-updateBankAccountBalance","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"balanceid","in":"path","description":"The BALANCEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","balance_type"],"properties":{"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"balance_amount":{"type":"string"},"balance_type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["balance_amount","bank_id","balance_id","account_id","balance_type"],"properties":{"balance_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Account","Balance"],"summary":"Delete Bank Account Balance","description":"Delete a Bank Account Balance specified by BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteBankAccountBalance","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"balanceid","in":"path","description":"The BALANCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/banks/{bankid}/customer/messages":{"get":{"tags":["Customer-Message","Customer"],"summary":"Get Customer Messages for all Customers","description":"Get messages for the logged in customer
\nMessages sent to the currently authenticated user.
Authentication via OAuth is required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndate: 2020-01-27
\nfrom_department: Open Bank
\nfrom_person: Tom
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nmessage: 123456
\n\n","operationId":"OBPv1.4.0-getCustomersMessages","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["messages"],"properties":{"messages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message","from_department","id","date","from_person"],"properties":{"from_person":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"from_department":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"from_person":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/my/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for the current User","description":"Get Entitlements for the current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","operationId":"OBPv3.0.0-getEntitlementsForCurrentUser","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/atms":{"head":{"tags":["ATM"],"summary":"Head Bank ATMS","description":"Head Bank ATMS.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natms:
\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n","operationId":"OBPv5.0.0-headAtms","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["atms"],"properties":{"atms":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-resource-docs":{"get":{"tags":["Dynamic-Resource-Doc"],"summary":"Get all Bank Level Dynamic Resource Docs","description":"Get all Bank Level Dynamic Resource Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-getAllBankLevelDynamicResourceDocs","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic-resource-docs"],"properties":{"dynamic-resource-docs":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic-resource-docs":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Resource-Doc"],"summary":"Create Bank Level Dynamic Resource Doc","description":"Create a Bank Level Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","operationId":"OBPv4.0.0-createBankLevelDynamicResourceDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["tags","request_verb","example_request_body","bank_id","partial_function_name","success_response_body","roles","dynamic_resource_doc_id","summary","request_url","description","method_body","error_response_bodies"],"properties":{"error_response_bodies":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"success_response_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","hobby","my_user_id","age","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"my_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example_request_body":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","age","hobby","_optional_fields_"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"age":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hobby":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"_optional_fields_":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_resource_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"partial_function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/users/{provider}/{providerid}/sync":{"post":{"tags":["User"],"summary":"Sync User","description":"The endpoint is used to create or sync an OBP User with User from an external identity provider.
\nPROVIDER is the host of the provider e.g. a Keycloak Host.
\nPROVIDER_ID is the unique identifier for the User at the PROVIDER.
\nAt the end of the process, a User will exist in OBP with the Account Access records defined by the CBS.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\n\nJSON request body fields:
\nJSON response body fields:
\nduration_time: 60
\n","operationId":"OBPv5.1.0-syncExternalUser","parameters":[{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"providerid","in":"path","description":"The PROVIDERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["duration_time"],"properties":{"duration_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"duration_time":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/address":{"post":{"tags":["Customer"],"summary":"Create Address","description":"Create an Address for a Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\ncity:
\ncountry_code: 1254
\n\n\n\n\n\n\n\ntags: Create-My-User
\nJSON response body fields:
\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","operationId":"OBPv3.1.0-createCustomerAddress","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","tags","postcode","line_1","line_2","line_3","state","status","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"city":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","customer_id","tags","postcode","line_1","line_2","line_3","customer_address_id","state","status","insert_date","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_address_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"country_code":{"type":"string"},"county":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/currencies":{"get":{"tags":["FX"],"summary":"Get Currencies at a Bank","description":"Get Currencies specified by BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nalphanumeric_code: alphanumeric_code
\ncurrencies: currencies
\n","operationId":"OBPv5.1.0-getCurrenciesAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currencies"],"properties":{"currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["alphanumeric_code"],"properties":{"alphanumeric_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"alphanumeric_code":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.1.0/banks/{bankid}/transaction-request-types":{"get":{"tags":["Transaction-Request","Bank"],"summary":"Get Transaction Request Types at Bank","description":"Get the list of the Transaction Request Types supported by the bank.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ntransaction_request_type: SEPA
\n\n","operationId":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_request_type"],"properties":{"transaction_request_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"transaction_request_type":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{simple}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SIMPLE)","description":"Special instructions for SIMPLE:
\nYou can transfer money to the Bank Account Number or IBAN directly.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSIMPLE: SIMPLE
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestSimple","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"simple","in":"path","description":"The SIMPLE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["future_date","value","charge_policy","description","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["other_account_routing_address","description","other_bank_routing_scheme","other_account_secondary_routing_address","name","other_account_routing_scheme","other_bank_routing_address","other_branch_routing_scheme","other_account_secondary_routing_scheme","other_branch_routing_address"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"description":{"type":"string"},"to":{"type":"object","properties":{"other_account_routing_address":{"type":"string"},"description":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"name":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/mtls/certificate/current":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Provide client's certificate info of a current call","description":"Provide client's certificate info of a current call specified by PSD2-CERT value at Request Header
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nsubject_domain_name: subject_domain_name
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-mtlsClientCertificateInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/transactions/{transactionid}/attributes/{attributeid}":{"get":{"tags":["Transaction","Transaction-Attribute","Attribute"],"summary":"Get Transaction Attribute By Id","description":"Get Transaction Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getTransactionAttributeById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}},{"name":"attributeid","in":"path","description":"The ATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/direct-debit":{"post":{"tags":["Direct-Debit","Account"],"summary":"Create Direct Debit","description":"Create direct debit for an account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-createDirectDebit","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","counterparty_id","date_signed","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_signed":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_starts","customer_id","active","bank_id","counterparty_id","date_signed","direct_debit_id","date_expires","date_cancelled","account_id","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_cancelled":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"direct_debit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_signed":{"type":"string","format":"date-time"},"direct_debit_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"date_cancelled":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/banks/{bankid}/dynamic-entities/{dynamicentityid}/backup":{"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Backup Bank Level Dynamic Entity","description":"Create a backup copy of a bank level DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nThis endpoint creates a backup of the dynamic entity definition and all its data records.
\nThe backup entity will be named with a _BAK suffix (e.g. my_entity_BAK).
\nIf a backup with that name already exists, _BAK2, _BAK3 etc. will be used.
The calling user will be granted CanGetDynamicEntity_<BackupEntityName> on the newly created backup entity.
For more information see here
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-backupBankLevelDynamicEntity","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entity_id","has_community_access","bank_id","entity_name","personal_requires_role","user_id","has_public_access","schema","has_personal_entity"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"bank_id":{"type":"string"},"entity_name":{"type":"string"},"personal_requires_role":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}}}}}},"has_personal_entity":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/{accountid}/permissions/{provider}/{providerid}":{"get":{"tags":["View-Custom","Account","User"],"summary":"Get Account access for User","description":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
\nAll url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n\n","operationId":"OBPv3.0.0-getPermissionForUserForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"provider","in":"path","description":"The PROVIDER identifier","required":true,"schema":{"type":"string"}},{"name":"providerid","in":"path","description":"The PROVIDERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/consumer/consent-requests/{consentrequestid}/{sms}/consents":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent By CONSENT_REQUEST_ID (SMS)","description":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent you are creating cannot exceed the entitlements that the User creating this consents already has.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nSMS:
\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","operationId":"OBPv5.0.0-createConsentByConsentRequestIdSms","parameters":[{"name":"consentrequestid","in":"path","description":"The CONSENTREQUESTID identifier","required":true,"schema":{"type":"string"}},{"name":"sms","in":"path","description":"The SMS identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access","consent_request_id","consent_id","status","jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/corporate_location":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Corporate Location","description":"Update the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyCorporateLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["corporate_location"],"properties":{"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Corporate Location to Counterparty","description":"Add the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyCorporateLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["corporate_location"],"properties":{"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Corporate Location","description":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyCorporateLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/more_info":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty More Info","description":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyMoreInfo","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["more_info"],"properties":{"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"more_info":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Counterparty More Info","description":"Add a description of the counter party from the perpestive of the account e.g. My dentist
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nmore_info: More information about this fee
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyMoreInfo","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["more_info"],"properties":{"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"more_info":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete more info of other bank account","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyMoreInfo","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/url":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update url of other bank account","description":"A url which represents the counterparty (home page url etc.)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add url to other bank account","description":"A url which represents the counterparty (home page url etc.)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["URL"],"properties":{"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete url of other bank account","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/config-props":{"get":{"tags":["API"],"summary":"Get Config Props","description":"Get the configuration properties (non-WebUI) and their runtime values.
\nThis endpoint reads all property keys from the sample.props.template file
\n(excluding webui_ properties) and returns their current runtime values.
Sensitive properties (containing password, secret, passphrase, credential, token_secret)
\nwill have their values masked as ****.
Authentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","operationId":"OBPv6.0.0-getConfigProps","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["config_props"],"properties":{"config_props":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"config_props":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/consumers/{consumerid}":{"get":{"tags":["Consumer"],"summary":"Get Consumer","description":"Get the Consumer specified by CONSUMER_ID.
\nThis endpoint returns all consumer fields including:
\n- Basic info: consumer_id, app_name, app_type, description, developer_email, company
\n- OAuth: consumer_key, redirect_url
\n- Status: enabled, created
\n- Certificate: certificate_pem, certificate_info (subject, issuer, validity dates, PSD2 roles)
\n- Branding: logo_url
\n- Creator: created_by_user details
\n- Rate limits: active_rate_limits showing current rate limiting configuration
\n- Call counters: call_counters showing current API call usage from Redis
Note: consumer_secret is never returned for security reasons.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nactive_at_date: active_at_date
\nactive_per_day_rate_limit: active_per_day_rate_limit
\nactive_per_hour_rate_limit: active_per_hour_rate_limit
\nactive_per_minute_rate_limit: active_per_minute_rate_limit
\nactive_per_month_rate_limit: active_per_month_rate_limit
\nactive_per_second_rate_limit: active_per_second_rate_limit
\nactive_per_week_rate_limit: active_per_week_rate_limit
\nactive_rate_limits: active_rate_limits
\napp_name: appNameBank
\napp_type: Web
\ncall_counters: call_counters
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsidered_rate_limit_ids: considered_rate_limit_ids
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nper_day: 4000
\n\n\nper_month: 500
\nper_second: 1000
\nper_week: 50000
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\n\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncalls_made: 50
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\n\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv6.0.0-getConsumer","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","call_counters","app_type","active_rate_limits","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_rate_limits":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["active_per_minute_rate_limit","active_per_hour_rate_limit","active_per_day_rate_limit","active_per_second_rate_limit","considered_rate_limit_ids","active_at_date","active_per_week_rate_limit","active_per_month_rate_limit"],"properties":{"active_at_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"active_per_second_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_day_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_week_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"considered_rate_limit_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"active_per_minute_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_month_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_hour_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"call_counters":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["per_month","per_hour","per_week","per_second","per_minute","per_day"],"properties":{"per_week":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_second":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_month":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_day":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_minute":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_hour":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"call_counters":{"type":"object","properties":{"per_month":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_hour":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_week":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_second":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_minute":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_day":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}}}},"app_type":{"type":"string"},"active_rate_limits":{"type":"object","properties":{"active_per_minute_rate_limit":{"type":"integer"},"active_per_hour_rate_limit":{"type":"integer"},"active_per_day_rate_limit":{"type":"integer"},"active_per_second_rate_limit":{"type":"integer"},"considered_rate_limit_ids":{"type":"array","items":{"type":"string"}},"active_at_date":{"type":"string","format":"date-time"},"active_per_week_rate_limit":{"type":"integer"},"active_per_month_rate_limit":{"type":"integer"}}},"app_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/image_url":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Image Url","description":"Update the url that points to the logo of the counterparty
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyImageUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL"],"properties":{"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"image_URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add image url to other bank account","description":"Add a url that points to the logo of the counterparty
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyImageUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL"],"properties":{"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"image_URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Image URL","description":"Delete image url of other bank account
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyImageUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}}}},"/obp/v3.0.0/my/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlement Requests for the current User","description":"Get Entitlement Requests for the current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","operationId":"OBPv3.0.0-getEntitlementRequestsForCurrentUser","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_requests"],"properties":{"entitlement_requests":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_request_id","role_name","bank_id","user","created"],"properties":{"entitlement_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"created":{"type":"string","format":"date-time"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/account-access/grant":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to View","description":"Grants the User identified by USER_ID access to the view on a bank account identified by VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPermission Requirements:
\nThe requesting user must have access to the source VIEW_ID and must possess specific grant permissions:
For System Views (e.g., owner, accountant, auditor, public etc.):
\n- The user's current view must have the target view listed in its canGrantAccessToViews field
\n- Example: If granting access to "accountant" view, the user's view must include "accountant" in canGrantAccessToViews
For Custom Views (account-specific views):
\n- The user's current view must have the can_grant_access_to_custom_views permission in its allowed_actions field
\n- This permission allows granting access to any custom view on the account
Security Checks Performed:
\n1. User authentication validation
\n2. JSON format validation (USER_ID and VIEW_ID required)
\n3. Permission authorization via APIUtil.canGrantAccessToView()
\n4. Target user existence verification
\n5. Target view existence and type validation (system vs custom)
\n6. Final access grant operation in database
Final Database Operation:
\nThe system creates an AccountAccess record linking the user to the view if one doesn't already exist.
\nThis operation includes:
\n- Duplicate check: Prevents creating duplicate access records (idempotent operation)
\n- Public view restriction: Blocks access to public views if disabled instance-wide
\n- Database constraint validation: Ensures referential integrity
Note: The permission model ensures users can only delegate access rights they themselves possess or are explicitly authorized to grant.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv5.1.0-grantUserAccessToViewById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["view_id","user_id"],"properties":{"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"view_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/json-schema-validations":{"get":{"tags":["JSON-Schema-Validation"],"summary":"Get all JSON Schema Validations","description":"Get all JSON Schema Validations.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv6.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","operationId":"OBPv4.0.0-getAllJsonSchemaValidations","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema_validations"],"properties":{"json_schema_validations":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["json_schema","operation_id"],"properties":{"json_schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","required","$schema","description","type","properties","additionalProperties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["xxx_id"],"properties":{"xxx_id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","maxLength","type","examples"],"properties":{"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"$schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"json_schema_validations":{"type":"array","items":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/management/metrics/banks/{bankid}":{"get":{"tags":["Metric","API"],"summary":"Get Metrics at Bank","description":"Get the all metrics at the Bank specified by BANK_ID
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) non digit chars will be silently omitted
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napp_name: appNameBank
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nverb:
\n","operationId":"OBPv5.0.0-getMetricsAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["app_name","implemented_in_version","developer_email","consumer_id","verb","implemented_by_partial_function","date","user_name","url","duration","correlation_id","user_id"],"properties":{"duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"implemented_in_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"correlation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"implemented_by_partial_function":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"verb":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"implemented_in_version":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"verb":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"date":{"type":"string","format":"date-time"},"user_name":{"type":"string"},"url":{"type":"string"},"duration":{"type":"integer"},"correlation_id":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/consents/{consentid}":{"put":{"tags":["Consent","Account Information Service (AIS)"],"summary":"Update Consent Status","description":"This endpoint is used to update the Status of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv4.0.0-updateConsentStatus","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/consents/{consentid}":{"delete":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Revoke Consent at Bank","description":"Revoke Consent specified by CONSENT_ID
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-revokeConsentAtBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/dynamic-entities/reference-types":{"get":{"tags":["Dynamic-Entity","API"],"summary":"Get Reference Types for Dynamic Entities","description":"Get a list of all available reference types that can be used in Dynamic Entity field definitions.
\nReference types allow Dynamic Entity fields to reference other entities (similar to foreign keys).
\nThis endpoint returns both:
\n* Static reference types - Built-in reference types for core OBP entities (e.g., Customer, Account, Transaction)
\n* Dynamic reference types - Reference types for Dynamic Entities that have been created
Each reference type includes:
\n* type_name - The full reference type string to use in entity definitions (e.g., "reference:Customer")
\n* example_value - An example value showing the correct format
\n* description - Description of what the reference type represents
Use Case:
\nWhen creating a Dynamic Entity with a field that references another entity, you need to know:
\n1. What reference types are available
\n2. The correct format for the type name
\n3. The correct format for example values
This endpoint provides all that information.
\nExample Usage:
\nIf you want to create a Dynamic Entity with a field that references a Customer, you would:
\n1. Call this endpoint to see that "reference:Customer" is available
\n2. Use it in your entity definition like:
{\n "customer_id": {\n "type": "reference:Customer",\n "example": "a8770fca-3d1d-47af-b6d0-7a6c3f124388"\n }\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nRequired Role: CanGetDynamicEntityReferenceTypes
Returns only the list of accounts ids at BANK_ID that the user has access to.
\nEach account must have at least one private View.
\nFor each account the API returns its account ID.
\nIf you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n","operationId":"OBPv3.0.0-getPrivateAccountIdsbyBankId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/custom-views":{"get":{"tags":["View-Custom","View-System"],"summary":"Get Custom Views","description":"Get all custom views.
\nCustom views are user-created views with names starting with underscore (_), such as:
\n- _work
\n- _personal
\n- _audit
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\n","operationId":"OBPv6.0.0-getCustomViews","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views"],"properties":{"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}},"example":{"type":"object","properties":{"views":{"type":"object","properties":{}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/addresses/{customeraddressid}":{"put":{"tags":["Customer"],"summary":"Update the Address of a Customer","description":"Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","operationId":"OBPv3.1.0-updateCustomerAddress","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"customeraddressid","in":"path","description":"The CUSTOMERADDRESSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","tags","postcode","line_1","line_2","line_3","state","status","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"city":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","customer_id","tags","postcode","line_1","line_2","line_3","customer_address_id","state","status","insert_date","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_address_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"country_code":{"type":"string"},"county":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Customer","KYC"],"summary":"Delete Customer Address","description":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteCustomerAddress","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"customeraddressid","in":"path","description":"The CUSTOMERADDRESSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.1.0/sandbox/data-import":{"post":{"tags":["Sandbox"],"summary":"Create sandbox","description":"Import bulk data into the sandbox (Authenticated access).
\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
\nThe user needs to have CanCreateSandbox entitlement.
\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
\nAn example of an import set of data (json) can be found here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\nactual_date: 2020-01-27
\n\namount: 10.12
\natms:
\nbalance: 10
\nbank:
\nbank_id: gh.29.uk
\n\n\n\n\ncity:
\ncode: 125
\ncompleted: 2020-01-27
\ncountry_code: 1254
\n\n\ncurrency: EUR
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nfull_name: full name string
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nlatitude: 38.8951
\n\n\n\n\n\nlogo: logo url
\nlongitude: -77.0364
\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\n\npassword: password
\npost_code: 789
\nposted: 2020-01-27
\n\n\n\n\n\n\ntype:
\nuser_name: felixsmith
\nusers: user list
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\naccount_number: 546387432
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\n\n","operationId":"OBPv2.1.0-sandboxDataImport","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts","branches","transactions","products","atms","crm_events","users","banks"],"properties":{"crm_events":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["channel","actual_date","bank_id","customer","category","id","detail"],"properties":{"channel":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","name"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"actual_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}},"users":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","user_name","password"],"properties":{"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"password":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"products":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["family","name","category","bank_id","super_family","meta","code","more_info_url"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"super_family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"family":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"banks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["full_name","short_name","logo","website","id"],"properties":{"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branches":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","location","address","driveUp","lobby","bank_id","meta","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"driveUp":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hours"],"properties":{"hours":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"lobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hours"],"properties":{"hours":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["line_2","county","line_3","state","country_code","post_code","line_1","city"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"transactions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","this_account","details"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["id","bank"],"properties":{"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","new_balance","type","completed","posted","description"],"properties":{"new_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"completed":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"posted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["IBAN","generate_accountants_view","owners","generate_public_view","bank","id","generate_auditors_view","label","number","balance","type"],"properties":{"generate_auditors_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"IBAN":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"generate_accountants_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"generate_public_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"atms":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","location","address","bank_id","meta","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["line_2","county","line_3","state","country_code","post_code","line_1","city"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"post_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"IBAN":{"type":"string"},"generate_accountants_view":{"type":"boolean"},"owners":{"type":"array","items":{"type":"string"}},"generate_public_view":{"type":"boolean"},"bank":{"type":"string"},"id":{"type":"string"},"generate_auditors_view":{"type":"boolean"},"label":{"type":"string"},"number":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"type":{"type":"string"}}}},"branches":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"driveUp":{"type":"object","properties":{"hours":{"type":"string"}}},"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"this_account":{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"}}},"details":{"type":"object","properties":{"value":{"type":"string"},"new_balance":{"type":"string"},"type":{"type":"string"},"completed":{"type":"string"},"posted":{"type":"string"},"description":{"type":"string"}}}}}},"products":{"type":"array","items":{"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"bank_id":{"type":"string"},"super_family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"code":{"type":"string"},"more_info_url":{"type":"string"}}}},"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"crm_events":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer":{"type":"object","properties":{"number":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"string"},"id":{"type":"string"},"detail":{"type":"string"}}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"user_name":{"type":"string"},"password":{"type":"string"}}}},"banks":{"type":"array","items":{"type":"object","properties":{"full_name":{"type":"string"},"short_name":{"type":"string"},"logo":{"type":"string"},"website":{"type":"string"},"id":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{accountotp}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (ACCOUNT_OTP)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestAccountOtp","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"accountotp","in":"path","description":"The ACCOUNTOTP identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","description","value"],"properties":{"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}/attribute":{"post":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Create Product Attribute","description":"Create Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nTypical product attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-createProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","name","is_active"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","product_attribute_id","bank_id","type","name","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/system-views":{"get":{"tags":["View-System","View-Custom"],"summary":"Get System Views","description":"Get all system views.
\nSystem views are predefined views that apply to all accounts, such as:
\n- owner
\n- accountant
\n- auditor
\n- standard
Each view is returned with an allowed_actions array containing all permissions for that view.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\n\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_revoke_access_to_views: can_revoke_access_to_views
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\nis_system: true
\n\n\nview_id: owner
\n\n\n","operationId":"OBPv6.0.0-getSystemViews","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views"],"properties":{"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","is_firehose","allowed_actions","hide_metadata_if_alias_used","is_system","is_public","metadata_view","view_id","can_revoke_access_to_views","can_grant_access_to_views","alias","description"],"properties":{"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_firehose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"is_firehose":{"type":"boolean"},"allowed_actions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"is_system":{"type":"boolean"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"view_id":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"alias":{"type":"string"},"description":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/open_corporates_url":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Open Corporates Url of Counterparty","description":"Update open corporate url of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Open Corporates URL to Counterparty","description":"Add open corporates url to other bank account
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Open Corporates URL","description":"Delete open corporate url of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/users/current":{"get":{"tags":["User"],"summary":"Get User (Current)","description":"Get the logged in user
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\n\n","operationId":"OBPv6.0.0-getCurrentUser","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","entitlements","username","views","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/customers-minimal":{"get":{"tags":["Customer","User"],"summary":"Get Customers Minimal at Bank","description":"Get Customers Minimal at Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n","operationId":"OBPv5.0.0-getCustomersMinimalAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","bank_id"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-message-docs/{dynamicmessagedocid}":{"get":{"tags":["Dynamic-Message-Doc"],"summary":"Get Bank Level Dynamic Message Doc","description":"Get a Bank Level Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-getBankLevelDynamicMessageDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Dynamic-Message-Doc"],"summary":"Update Bank Level Dynamic Message Doc","description":"Update a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","operationId":"OBPv4.0.0-updateBankLevelDynamicMessageDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["example_outbound_message","outbound_topic","example_inbound_message","bank_id","inbound_topic","programming_lang","dynamic_message_doc_id","process","outbound_avro_schema","method_body","description","message_format","adapter_implementation","inbound_avro_schema"],"properties":{"adapter_implementation":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_inbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"process":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message_format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"programming_lang":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example_outbound_message":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_message_doc_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_avro_schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_body":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"outbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"inbound_topic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Message-Doc"],"summary":"Delete Bank Level Dynamic Message Doc","description":"Delete a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteBankLevelDynamicMessageDoc","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"dynamicmessagedocid","in":"path","description":"The DYNAMICMESSAGEDOCID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/system-views":{"post":{"tags":["View-System"],"summary":"Create System View","description":"Create a system view
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the CanCreateSystemView entitlement.
\nThe 'allowed_actions' field is a list containing the names of the actions allowed through this view.
\nAll the actions contained in the list will be set to true on the view creation, the rest will be set to false.
The 'alias' field in the JSON can take one of three values:
\nThe '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.
System views cannot be public. In case you try to set it you will get the error OBP-30258: System view cannot be public
\nJSON request body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_revoke_access_to_views: can_revoke_access_to_views
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","operationId":"OBPv5.0.0-createSystemView","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["hide_metadata_if_alias_used","description","is_public","which_alias_to_use","can_revoke_access_to_views","can_grant_access_to_views","name","allowed_actions","metadata_view"],"properties":{"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}},"metadata_view":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_see_other_account_swift_bic","can_see_where_tag","can_see_url","can_create_direct_debit","can_see_bank_account_swift_bic","can_see_bank_account_routing_address","can_see_tags","can_see_transaction_balance","can_delete_corporate_location","can_add_image_url","can_see_public_alias","can_add_transaction_request_to_own_account","can_add_comment","can_see_other_bank_routing_scheme","description","can_see_corporate_location","can_see_other_account_bank_name","can_see_more_info","can_add_counterparty","is_system","can_see_physical_location","can_query_available_funds","can_edit_owner_comment","can_see_private_alias","can_see_bank_account_credit_limit","can_see_other_account_routing_address","can_see_bank_account_balance","can_add_public_alias","can_see_bank_routing_scheme","can_see_bank_account_owners","can_see_other_account_metadata","can_delete_physical_location","hide_metadata_if_alias_used","can_see_transaction_this_bank_account","can_see_image_url","can_see_transaction_type","can_see_images","can_see_transaction_amount","metadata_view","can_see_transaction_metadata","can_see_comments","can_see_other_account_iban","can_add_image","can_see_bank_account_routing_scheme","can_see_bank_account_type","can_see_other_account_kind","can_see_bank_account_currency","can_add_where_tag","can_see_transaction_start_date","can_see_bank_account_label","can_add_private_alias","can_see_transaction_currency","can_revoke_access_to_views","can_add_more_info","can_delete_comment","can_create_standing_order","can_see_other_bank_routing_address","can_grant_access_to_views","can_see_transaction_other_bank_account","can_see_bank_account_number","can_add_corporate_location","alias","can_add_url","short_name","can_delete_where_tag","is_public","can_see_owner_comment","can_see_transaction_finish_date","can_see_open_corporates_url","can_add_physical_location","can_see_bank_account_iban","can_see_other_account_national_identifier","can_see_bank_routing_address","can_delete_image","can_add_transaction_request_to_any_account","can_add_tag","id","can_see_other_account_routing_scheme","can_add_open_corporates_url","can_delete_tag","can_see_transaction_description","can_see_bank_account_national_identifier","can_see_other_account_number","can_see_bank_account_bank_name"],"properties":{"can_see_transaction_start_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_this_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_bank_account_owners":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_edit_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_owner_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_other_bank_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_bank_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_direct_debit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_kind":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_own_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_finish_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_images":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_query_available_funds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_credit_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_create_standing_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_national_identifier":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_counterparty":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_transaction_request_to_any_account":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"can_see_tags":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_where_tag":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_swift_bic":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_physical_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_add_corporate_location":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_delete_image":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_account_metadata":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_bank_account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_see_transaction_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/customers/{customerid}/kyc_check/{kyccheckid}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Check","description":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","operationId":"OBPv2.0.0-addKycCheck","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"kyccheckid","in":"path","description":"The KYCCHECKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number","date","staff_user_id","staff_name","comments","how","satisfied"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"how":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"satisfied":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"staff_user_id":{"type":"string"},"staff_name":{"type":"string"},"comments":{"type":"string"},"how":{"type":"string"},"satisfied":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["comments","customer_id","staff_user_id","bank_id","customer_number","date","id","satisfied","how","staff_name"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"how":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"satisfied":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"comments":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/account-access-requests/{accountaccessrequestid}":{"get":{"tags":["Account-Access-Request"],"summary":"Get Account Access Request by Id","description":"Get a single Account Access Request by its ID.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ACCESS_REQUEST_ID: ACCOUNT_ACCESS_REQUEST_ID
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-getAccountAccessRequestById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"accountaccessrequestid","in":"path","description":"The ACCOUNTACCESSREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","created","account_access_request_id","is_system_view","business_justification","bank_id","view_id","target_user_id","checker_user_id","status","updated","account_id","checker_comment"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"status":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"checker_comment":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/card":{"get":{"tags":["Card","Card-Attribute","Attribute"],"summary":"Get Card Attribute Definition","description":"Get Card Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getCardAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","category","bank_id","name","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Card","Card-Attribute","Attribute"],"summary":"Create or Update Card Attribute Definition","description":"Create or Update Card Attribute Definition
\nThe category field must be Card
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateCardAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","category","name","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","category","bank_id","name","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/regulated-entities/{regulatedentityid}/attributes":{"get":{"tags":["Directory","API"],"summary":"Get All Regulated Entity Attributes","description":"Get all attributes for the specified Regulated Entity.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nattributes: attribute value in form of (name, value)
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-getAllRegulatedEntityAttributes","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["regulated_entity_attribute_id","name","attribute_type","value","regulated_entity_id","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Directory","API"],"summary":"Create Regulated Entity Attribute","description":"Create a new Regulated Entity Attribute for a given REGULATED_ENTITY_ID.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or "DATE_WITH_DAY".
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON request body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-createRegulatedEntityAttribute","parameters":[{"name":"regulatedentityid","in":"path","description":"The REGULATEDENTITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attribute_type","value","is_active","name"],"properties":{"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"attribute_type":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["regulated_entity_attribute_id","name","attribute_type","value","regulated_entity_id","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"regulated_entity_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/atms":{"get":{"tags":["ATM"],"summary":"Get Bank ATMS","description":"Returns information about ATMs for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 100 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\natms:
\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","operationId":"OBPv5.1.0-getAtms","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["atms"],"properties":{"atms":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","attributes","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["ATM"],"summary":"Create ATM","description":"Create ATM.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","operationId":"OBPv5.1.0-createAtm","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","site_name","friday","id","is_accessible","site_identification","atm_type","accessibility_features","supported_currencies","bank_id","monday","cash_withdrawal_international_fee","has_deposit_capability","supported_languages","balance_inquiry_fee","meta","notes","saturday","thursday","tuesday","wednesday","phone","sunday","located_at","more_info","address","minimum_withdrawal","branch_identification","attributes","location","services","cash_withdrawal_national_fee","location_categories"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_international_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location_categories":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"site_identification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"has_deposit_capability":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance_inquiry_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"site_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"supported_languages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"supported_currencies":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","postcode","line_1","line_2","line_3","state","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cash_withdrawal_national_fee":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"located_at":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minimum_withdrawal":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/Odometer/{odometerid}":{"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer by id","description":"Get Odometer by id.
\nVerify odometer information for flexible contracts.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"Odometer"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleOdometer_gh.29.uk","parameters":[{"name":"odometerid","in":"path","description":"The ODOMETERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","odometer"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"odometer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["odometer_id","name","number"],"properties":{"odometer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Odometer","description":"Update Odometer.
\nVerify odometer information for flexible contracts.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"Odometer"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateOdometer_gh.29.uk","parameters":[{"name":"odometerid","in":"path","description":"The ODOMETERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","odometer"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"odometer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["odometer_id","name","number"],"properties":{"odometer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Odometer by id","description":"Delete Odometer by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"Odometer"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteOdometer_gh.29.uk","parameters":[{"name":"odometerid","in":"path","description":"The ODOMETERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","odometer"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"odometer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["odometer_id","name","number"],"properties":{"odometer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers at All Banks","description":"Get Customers at All Banks.
\nReturns a list of all customers across all banks.
\nDate Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
Query Parameters:
\n- limit: Maximum number of customers to return (optional)
\n- offset: Number of customers to skip for pagination (optional)
\n- sort_direction: Sort direction - ASC or DESC (optional)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCustomersAtAllBanks","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/retail-customers":{"get":{"tags":["Retail-Customer","Customer"],"summary":"Get Retail Customers at Bank","description":"Get Retail (Individual) Customers at Bank.
\nReturns a list of customers with customer_type INDIVIDUAL at the specified bank.
\nDate Format:
\ndate_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD
Query Parameters:
\n- limit: Maximum number of customers to return (optional)
\n- offset: Number of customers to skip for pagination (optional)
\n- sort_direction: Sort direction - ASC or DESC (optional)
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getRetailCustomersAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Retail-Customer","Customer"],"summary":"Create Retail Customer","description":"Create a retail (individual) customer.
\nThis endpoint is specifically for creating individual/retail customers.
\nThe customer_type will be automatically set to INDIVIDUAL.
Required Fields:
\n- legal_name: The customer's full legal name
\n- mobile_phone_number: The customer's mobile phone number
Optional Fields:
\n- customer_number: If not provided, a random number will be generated
\n- email, face_image, date_of_birth, relationship_status, dependants, dob_of_dependants
\n- credit_rating, credit_limit, highest_education_attained, employment_status
\n- kyc_status, last_ok_date, title, branch_id, name_suffix
Date Format:
\ndate_of_birth and dob_of_dependants must be in ISO 8601 date format: YYYY-MM-DD
Validations:
\n- customer_number cannot contain :::: characters
\n- customer_number must be unique for the bank
\n- The number of dependants must equal the length of the dob_of_dependants array
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndate: 2020-01-27
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nbranch_id: DERBY6
\n\n\ncustomer_number: 5987953
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-createRetailCustomer","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["relationship_status","name_suffix","highest_education_attained","credit_limit","date_of_birth","title","face_image","dob_of_dependants","credit_rating","email","customer_number","kyc_status","legal_name","branch_id","employment_status","mobile_phone_number","dependants","last_ok_date"],"properties":{"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"relationship_status":{"type":"string"},"name_suffix":{"type":"string"},"highest_education_attained":{"type":"string"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"date_of_birth":{"type":"string","format":"date-time"},"title":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"email":{"type":"string"},"customer_number":{"type":"string"},"kyc_status":{"type":"boolean"},"legal_name":{"type":"string"},"branch_id":{"type":"string"},"employment_status":{"type":"string"},"mobile_phone_number":{"type":"string"},"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/customers/{customerid}/messages":{"get":{"tags":["Customer-Message","Customer"],"summary":"Get Customer Messages for a Customer","description":"Get messages for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ndate: 2020-01-27
\nfrom_department: Open Bank
\nfrom_person: Tom
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nmessage: 123456
\n\ntransport: SMS
\n","operationId":"OBPv4.0.0-getCustomerMessages","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["messages"],"properties":{"messages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message","transport","id","date","from_person","from_department"],"properties":{"from_person":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transport":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"from_department":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"transport":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"from_person":{"type":"string"},"from_department":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","description":"Create a message for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_department: Open Bank
\nfrom_person: Tom
\nmessage: 123456
\ntransport: SMS
\nJSON response body fields:
\n\n","operationId":"OBPv4.0.0-createCustomerMessage","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["message","transport","from_person","from_department"],"properties":{"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transport":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_person":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_department":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"message":{"type":"string"},"transport":{"type":"string"},"from_person":{"type":"string"},"from_department":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules/{abacruleid}/execute":{"post":{"tags":["ABAC"],"summary":"Execute ABAC Rule","description":"Execute an ABAC rule to test access control.
\nThis endpoint allows you to test an ABAC rule with specific context (authenticated user, bank, account, transaction, customer, etc.).
\nDocumentation:
\n- here - Getting started with ABAC rules
\n- here - Complete list of all 18 parameters
\n- here - Detailed property reference
\n- here - Testing examples and patterns
You can provide optional IDs in the request body to test the rule with specific context.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nABAC_RULE_ID: ABAC_RULE_ID
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nauthenticated_user_id: authenticated_user_id
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\non_behalf_of_user_id: on_behalf_of_user_id
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n","operationId":"OBPv6.0.0-executeAbacRule","parameters":[{"name":"abacruleid","in":"path","description":"The ABACRULEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","bank_id","authenticated_user_id","transaction_id","view_id","on_behalf_of_user_id","user_id","account_id","transaction_request_id"],"properties":{"transaction_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"on_behalf_of_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"authenticated_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"},"authenticated_user_id":{"type":"string"},"transaction_id":{"type":"string"},"view_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"},"user_id":{"type":"string"},"account_id":{"type":"string"},"transaction_request_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["result"],"properties":{"result":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"result":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/groups/{groupid}":{"get":{"tags":["Group"],"summary":"Get Group","description":"Get a group by its ID.
\nRequires either:
\n- CanGetGroupsAtAllBanks (for any group)
\n- CanGetGroupsAtOneBank (for groups at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nGROUP_ID: GROUP_ID
\nJSON response body fields:
\ngroup_description: group_description
\ngroup_id: group_id
\ngroup_name: group_name
\nis_enabled: is_enabled
\nlist_of_roles: list_of_roles
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-getGroup","parameters":[{"name":"groupid","in":"path","description":"The GROUPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_id","group_description","bank_id","is_enabled","list_of_roles"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_name":{"type":"string"},"group_id":{"type":"string"},"group_description":{"type":"string"},"bank_id":{"type":"string"},"is_enabled":{"type":"boolean"},"list_of_roles":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Group"],"summary":"Update Group","description":"Update a group. All fields are optional.
\nRequires either:
\n- CanUpdateGroupAtAllBanks (for any group)
\n- CanUpdateGroupAtOneBank (for groups at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nGROUP_ID: GROUP_ID
\nJSON response body fields:
\ngroup_description: group_description
\ngroup_id: group_id
\ngroup_name: group_name
\nis_enabled: is_enabled
\nlist_of_roles: list_of_roles
\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-updateGroup","parameters":[{"name":"groupid","in":"path","description":"The GROUPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_name","group_description","list_of_roles","is_enabled"],"properties":{"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_name":{"type":"string"},"group_description":{"type":"string"},"list_of_roles":{"type":"array","items":{"type":"string"}},"is_enabled":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["group_id","list_of_roles","bank_id","is_enabled","group_name","group_description"],"properties":{"group_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"list_of_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"group_description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"group_id":{"type":"string"},"list_of_roles":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"is_enabled":{"type":"boolean"},"group_name":{"type":"string"},"group_description":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Group"],"summary":"Delete Group","description":"Delete a Group.
\nRequires either:
\n- CanDeleteGroupAtAllBanks (for any group)
\n- CanDeleteGroupAtOneBank (for groups at specific bank)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nGROUP_ID: GROUP_ID
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteGroup","parameters":[{"name":"groupid","in":"path","description":"The GROUPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/consumers/{consumerid}":{"put":{"tags":["Consumer"],"summary":"Enable or Disable Consumers","description":"Enable/Disable a Consumer specified by CONSUMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nenabled: false
\n","operationId":"OBPv3.1.0-enableDisableConsumers","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/meetings":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meetings","description":"Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
\nThe actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","operationId":"OBPv3.1.0-getMeetings","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["meetings"],"properties":{"meetings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["present","invitees","bank_id","when","provider_id","purpose_id","keys","creator","meeting_id"],"properties":{"present":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["staff_user_id","customer_user_id"],"properties":{"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"creator":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"invitees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","contact_details"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contact_details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"meeting_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"keys":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_token","session_id","staff_token"],"properties":{"customer_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"session_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Create Meeting (video conference/call)","description":"Create Meeting: Initiate a video conference/call with the bank.
\nThe Meetings resource contains meta data about video/other conference sessions
\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
\nLogin is required.
\nThis call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\ndate: 2020-01-27
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","operationId":"OBPv3.1.0-createMeeting","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["invitees","provider_id","purpose_id","creator","date"],"properties":{"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"creator":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"invitees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","contact_details"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contact_details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"purpose_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["present","invitees","bank_id","when","provider_id","purpose_id","keys","creator","meeting_id"],"properties":{"present":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["staff_user_id","customer_user_id"],"properties":{"staff_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"creator":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"invitees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","contact_details"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contact_details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"when":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"meeting_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"keys":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_token","session_id","staff_token"],"properties":{"customer_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"session_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"staff_token":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/dynamic-endpoints/{dynamicendpointid}":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Delete My Dynamic Endpoint","description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteMyDynamicEndpoint","parameters":[{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/api-collections/featured":{"get":{"tags":["Api-Collection"],"summary":"Get Featured Api Collections","description":"Get Featured Api Collections.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getFeaturedApiCollections","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collections"],"properties":{"api_collections":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/counterparties":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Account"],"summary":"Get Counterparties (Explicit)","description":"Get the Counterparties that have been explicitly created on the specified Account / View.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\n\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getExplicitCounterpartiesForAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparties"],"properties":{"counterparties":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"counterparties":{"type":"array","items":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty","Account"],"summary":"Create Counterparty (Explicit)","description":"This endpoint creates an (Explicit) Counterparty for an Account.
\nFor an introduction to Counterparties in OBP see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nvalue: 5987953
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-createCounterparty","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","other_account_routing_address","name","other_bank_routing_scheme","currency","other_account_secondary_routing_address","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","metadata","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["private_alias","physical_location","url","public_alias","open_corporates_url","more_info","corporate_location","image_url"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/my/accounts":{"get":{"tags":["Account","Account Information Service (AIS)","PrivateData","PSD2"],"summary":"Get Accounts at all Banks (private)","description":"Returns the list of accounts containing private views for the user.
\nEach account lists the views available to the user.
optional request parameters:
\nwhole url example:
\n/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\naccount_type: AC
\n\n\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nscheme: OBP
\n\n\n","operationId":"OBPv3.0.0-corePrivateAccountsAllBanks","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","account_type","bank_id","id","views","label"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","is_public","short_name","id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"id":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"is_public":{"type":"boolean"},"short_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/mobile-number":{"put":{"tags":["Customer"],"summary":"Update the mobile number of a Customer","description":"Update the mobile number of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerMobileNumber","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/api-collections":{"get":{"tags":["Api-Collection"],"summary":"Get All API Collections","description":"Get All API Collections.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv5.1.0-getAllApiCollections","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collections"],"properties":{"api_collections":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/SimonCovid":{"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid List","description":"Get SimonCovid List.
\nLet's put Covid99 stuff here
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"SimonCovid"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new SimonCovid.
\nLet's put Covid99 stuff here
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"SimonCovid"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createSimonCovid_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid"],"properties":{"simon_covid":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["simon_covid_id","name","number"],"properties":{"simon_covid_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get My Dynamic Endpoints","description":"Get My Dynamic Endpoints.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-getMyDynamicEndpoints","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/services":{"put":{"tags":["ATM"],"summary":"Update ATM Services","description":"Update ATM Services.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\n","operationId":"OBPv4.0.0-updateAtmServices","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["services"],"properties":{"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"services":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["atm_id","services"],"properties":{"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"services":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"atm_id":{"type":"string"},"services":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/metrics/top-apis":{"get":{"tags":["Metric","API"],"summary":"Get Top APIs","description":"Get metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.
\nThis v6.0.0 version includes the operation_id field which uniquely identifies each API endpoint
\nacross different API standards (OBP, Berlin Group, UK Open Banking, etc.).
Should be able to filter on the following fields:
\neg: /management/metrics/top-apis?from_date=1970-01-01T00:00:00.000Z&to_date=2026-02-25T15:15:28.475Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to one year ago): eg:from_date=1970-01-01T00:00:00.000Z
\n2 to_date (defaults to the current date) eg:to_date=2026-02-25T15:15:28.476Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two values: true (return where user_id is null) or false (return where user_id is not null)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore)
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore). eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore). You can design your own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore). eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanReadMetrics entitlement is required.
\nJSON response body fields:
\n\nimplemented_by_partial_function:
\n\noperation_id: OBPv6.0.0-getBanks
\n\n","operationId":"OBPv6.0.0-getTopAPIs","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["top_apis"],"properties":{"top_apis":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","implemented_by_partial_function","count","implemented_in_version"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"implemented_by_partial_function":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"implemented_in_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"top_apis":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"count":{"type":"integer"},"implemented_in_version":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/D-Entity1":{"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 List","description":"Get D-Entity1 List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"D-Entity1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new D-Entity1.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"D-Entity1"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createD-Entity1_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","d-entity1"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"d-entity1":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["d-entity1_id","name","number"],"properties":{"d-entity1_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Bank Level Dynamic Endpoints","description":"Get Bank Level Dynamic Endpoints.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-getBankLevelDynamicEndpoints","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Bank Level Dynamic Endpoint","description":"Create dynamic endpoints.
\nCreate dynamic endpoints with one json format swagger content.
\nIf the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
\nplease check Endpoint Mapping endpoints.
If the host of swagger is obp_mock, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-createBankLevelDynamicEndpoint","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/consumer/consent-requests":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent Request","description":"Client Authentication (mandatory)
\nIt is used when applications request an access token to access their own resources, not on behalf of a user.
\nThe client needs to authenticate themselves for this request.
\nIn case of public client we use client_id and private key to obtain access token, otherwise we use client_id and client_secret.
\nThe obtained access token is used in the HTTP Bearer auth header of our request.
Example:
\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0
After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent.
Application Access is Required. The Application must be authenticated.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\naccount_access: account_access
\n\n\nbank_id: gh.29.uk
\n\n\nscheme: OBP
\nview_id: owner
\nbank_id: gh.29.uk
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","operationId":"OBPv5.0.0-createConsentRequest","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlements","account_access","everything","phone_number","email","valid_from","consumer_id","time_to_live"],"properties":{"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["view_id","account_routing"],"properties":{"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"entitlements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"account_access":{"type":"array","items":{"type":"object","properties":{"view_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"everything":{"type":"boolean"},"phone_number":{"type":"string"},"email":{"type":"string"},"valid_from":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumer_id","consent_request_id","payload"],"properties":{"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"payload":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["phone_number","everything","account_access","valid_from","time_to_live"],"properties":{"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"time_to_live":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routing","view_id"],"properties":{"account_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"everything":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"valid_from":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"payload":{"type":"object","properties":{"phone_number":{"type":"string"},"everything":{"type":"boolean"},"account_access":{"type":"array","items":{"type":"object","properties":{"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"view_id":{"type":"string"}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/system/log-cache/debug":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Debug Level Log Cache","description":"Returns DEBUG level logs from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/debug?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheDebugEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/InsurancePolicy":{"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy List","description":"Get InsurancePolicy List.
\nWhich insurance policies the customer already has.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePolicy"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new InsurancePolicy.
\nWhich insurance policies the customer already has.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePolicy"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePolicy_gh.29.uk","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_policy"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_policy":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_policy_id","name","number"],"properties":{"insurance_policy_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request Types for Account","description":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
\nThese are the ways this API Server can create a Transaction via a Transaction Request
\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)
A Transaction Request Type internally determines:
\nFor instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.
\nThis approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\n\ncurrency: EUR
\n\n\nvalue: 5987953
\n","operationId":"OBPv1.4.0-getTransactionRequestTypes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["charge","value"],"properties":{"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","summary"],"properties":{"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"charge":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"}}},"value":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/cascading/banks/{bankid}/products/{productcode}":{"delete":{"tags":["Product"],"summary":"Delete Product Cascade","description":"Delete a Product Cascade specified by PRODUCT_CODE.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteProductCascade","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/user_id/{userid}":{"get":{"tags":["User"],"summary":"Get User by USER_ID","description":"Get user by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
URL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","operationId":"OBPv4.0.0-getUserByUserId","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","last_marketing_agreement_signed_date","provider_id","agreements","entitlements","is_deleted","is_locked","username","views","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"views":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"is_locked":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlements":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["role_name","bank_id","entitlement_id"],"properties":{"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entitlement_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"last_marketing_agreement_signed_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"agreements":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","text"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}/fees":{"get":{"tags":["Product"],"summary":"Get Product Fees","description":"Get Product Fees
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nproduct_fees: product_fees
\ntype:
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getProductFees","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_fees"],"properties":{"product_fees":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","is_active","bank_id","name","more_info","value","product_fee_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_fee_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","currency","frequency","amount"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"frequency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"product_fees":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v3.1.0/banks/{bankid}/accounts/{accountid}/products/{productcode}/attribute":{"post":{"tags":["Account","Account-Attribute","Attribute"],"summary":"Create Account Attribute","description":"Create Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\nJSON response body fields:
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv3.1.0-createAccountAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_instance_code","type","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/customers/legal-name":{"post":{"tags":["Customer","KYC"],"summary":"Get Customers by Legal Name","description":"Gets the Customers specified by Legal Name.
\nReturns a list of customers that match the provided legal name.
\nDate Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nlegal_name: Eveline Tripman
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCustomersByLegalName","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["legal_name"],"properties":{"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"legal_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system/connectors/stored_procedure_vDec2019/health":{"get":{"tags":["Connector","System","API"],"summary":"Get Stored Procedure Connector Health","description":"Returns health status of the stored procedure connector including:
\nSupports database-specific queries for: SQL Server, PostgreSQL, Oracle, and MySQL/MariaDB.
\nThis endpoint is useful for diagnosing connectivity issues, especially when the database is behind a load balancer
\nand you need to identify which node is responding or experiencing SSL certificate issues.
Note: This endpoint may take a long time to respond if the database connection is slow or experiencing issues.
\nThe response time depends on the connection pool timeout and JDBC driver settings.
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nresponse_time_ms: response_time_ms
\n\ndatabase_name: database_name
\nerror_message: error_message
\nserver_ip: server_ip
\nserver_name: server_name
\n","operationId":"OBPv6.0.0-getStoredProcedureConnectorHealth","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["server_ip","server_name","status","database_name","response_time_ms"],"properties":{"server_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"server_ip":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"database_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"response_time_ms":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"server_ip":{"type":"string"},"server_name":{"type":"string"},"status":{"type":"string"},"database_name":{"type":"string"},"response_time_ms":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2"],"summary":"Get Banks","description":"Get banks on this API instance
\nReturns a list of banks supported on this server:
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_id: gh.29.uk
\nbank_routings: bank routing in form of (scheme, address)
\n\nfull_name: full name string
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv6.0.0-getBanks","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["banks"],"properties":{"banks":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routings","website","logo","bank_id","attributes","bank_code","full_name"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"logo":{"type":"string"},"bank_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_code":{"type":"string"},"full_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Bank"],"summary":"Create Bank","description":"Create a new bank (Authenticated access).
\nThe user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
\nThus the User can manage the bank they create and assign Roles to other Users.
Only SANDBOX mode (i.e. when connector=mapped in properties file)\nThe settlement accounts are automatically created by the system when the bank is created.
\nName and account id are created in accordance to the next rules:
\n- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
\n- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\nbank_code: CGHZ
\nbank_id: gh.29.uk
\nscheme: OBP
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nlogo: logo url
\nwebsite: www.openbankproject.com
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_id: gh.29.uk
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","operationId":"OBPv6.0.0-createBank","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","full_name","logo","bank_code","website","bank_routings"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"full_name":{"type":"string"},"logo":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_routings","website","attributes","bank_id","logo","bank_code","full_name"],"properties":{"bank_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"website":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"full_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"logo":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/search/warehouse/statistics/{index}/{field}":{"post":{"tags":["Data-Warehouse"],"summary":"Data Warehouse Statistics","description":"Search the data warehouse and get statistical aggregations over a warehouse field
\nDoes a stats aggregation over some numeric field:
\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanSearchWarehouseStats Role is required. You can request this below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/statistics/INDEX/FIELD
\nPOST /search/warehouse/statistics/ALL/FIELD
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\nnone:
\n","operationId":"OBPv3.0.0-dataWarehouseStatistics","parameters":[{"name":"index","in":"path","description":"The INDEX identifier","required":true,"schema":{"type":"string"}},{"name":"field","in":"path","description":"The FIELD identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["query"],"properties":{"query":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["match_all"],"properties":{"match_all":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}}}}}}}}}},"example":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"example":{"type":"object","properties":{}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/my/api-collections/name/{apicollectionname}":{"get":{"tags":["Api-Collection"],"summary":"Get My Api Collection By Name","description":"Get Api Collection By API_COLLECTION_NAME.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getMyApiCollectionByName","parameters":[{"name":"apicollectionname","in":"path","description":"The APICOLLECTIONNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/web-hooks/account/notifications/on-create-transaction":{"post":{"tags":["Webhook","Bank"],"summary":"Create bank level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the specified Bank.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","operationId":"OBPv4.0.0-createBankAccountNotificationWebhook","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["http_method","http_protocol","url"],"properties":{"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","http_method","webhook_id","bank_id","http_protocol","trigger_name","url"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"trigger_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_protocol":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"http_method":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"webhook_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/system-views/{viewid}":{"put":{"tags":["View-System","View-Custom"],"summary":"Update System View","description":"Update an existing system view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe JSON sent is the same as during view creation, with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created).
The response contains the updated view with an allowed_actions array.
URL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_revoke_access_to_views: can_revoke_access_to_views
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\nis_system: true
\n\n\nview_id: owner
\n\n","operationId":"OBPv6.0.0-updateSystemView","parameters":[{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_firehose","which_alias_to_use","hide_metadata_if_alias_used","allowed_actions","can_grant_access_to_views","is_public","metadata_view","description","can_revoke_access_to_views"],"properties":{"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_firehose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"is_firehose":{"type":"boolean"},"which_alias_to_use":{"type":"string"},"hide_metadata_if_alias_used":{"type":"boolean"},"allowed_actions":{"type":"array","items":{"type":"string"}},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"description":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["short_name","is_firehose","hide_metadata_if_alias_used","is_system","allowed_actions","is_public","metadata_view","can_revoke_access_to_views","view_id","description","alias","can_grant_access_to_views"],"properties":{"can_grant_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_system":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_revoke_access_to_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"short_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_firehose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_actions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"short_name":{"type":"string"},"is_firehose":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"is_system":{"type":"boolean"},"allowed_actions":{"type":"array","items":{"type":"string"}},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"view_id":{"type":"string"},"description":{"type":"string"},"alias":{"type":"string"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/banks/{bankid}/crm-events":{"get":{"tags":["Customer"],"summary":"Get CRM Events","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nactual_date: 2020-01-27
\nbank_id: gh.29.uk
\n\n\n\n\ncustomer_number: 5987953
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nscheduled_date: 2020-01-27
\n","operationId":"OBPv1.4.0-getCrmEvents","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["crm_events"],"properties":{"crm_events":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheduled_date","bank_id","customer_number","id","result","customer_name","category","actual_date","detail","channel"],"properties":{"channel":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"result":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheduled_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"detail":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"actual_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"crm_events":{"type":"array","items":{"type":"object","properties":{"scheduled_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"},"result":{"type":"string"},"customer_name":{"type":"string"},"category":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"detail":{"type":"string"},"channel":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/users/{userid}/auth-context":{"get":{"tags":["User"],"summary":"Get User Auth Contexts","description":"Get User Auth Contexts for a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\ntime_stamp: 1100-01-01T01:01:01.000Z
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","operationId":"OBPv5.0.0-getUserAuthContexts","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumer_id","time_stamp","key","user_auth_context_id","value","user_id"],"properties":{"time_stamp":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_auth_context_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consumer_id":{"type":"string"},"time_stamp":{"type":"string","format":"date-time"},"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["User"],"summary":"Create User Auth Context","description":"Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
\nBank User/Customer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\ntime_stamp: 1100-01-01T01:01:01.000Z
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","operationId":"OBPv5.0.0-createUserAuthContext","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["key","value"],"properties":{"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consumer_id","time_stamp","key","user_auth_context_id","value","user_id"],"properties":{"time_stamp":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_auth_context_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"consumer_id":{"type":"string"},"time_stamp":{"type":"string","format":"date-time"},"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.4.0/banks/{bankid}/resource-docs/{apiversion}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Bank Level Dynamic Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis 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.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor 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.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif 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.
\nYou 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.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://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.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiversion","in":"path","description":"The APIVERSION identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/user/current/consents/{consentid}":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get Consent By Consent Id via User","description":"This endpoint gets the Consent By consent id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n","operationId":"OBPv5.1.0-getConsentByConsentId","parameters":[{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scopes","consumer_id","consent_request_id","consent_id","status","jwt"],"properties":{"scopes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}":{"get":{"tags":["Counterparty","Account"],"summary":"Get Other Account by Id","description":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
\nUser Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\n\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nprovider: ETHEREUM
\n\nscheme: OBP
\nuser:
\n","operationId":"OBPv3.0.0-getOtherAccountByIdForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","metadata","bank_routing","holder","id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"holder":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_alias","name"],"properties":{"is_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["image_URL","corporate_location","URL","open_corporates_URL","physical_location","public_alias","private_alias","more_info"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"image_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"open_corporates_URL":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/banks/gh.29.uk/InsurancePremium/{insurancepremiumid}":{"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium by id","description":"Get InsurancePremium by id.
\nRetrive the premium for the customer.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePremium"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePremium_gh.29.uk","parameters":[{"name":"insurancepremiumid","in":"path","description":"The INSURANCEPREMIUMID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_premium"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_premium":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_premium_id","name","number"],"properties":{"insurance_premium_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePremium","description":"Update InsurancePremium.
\nRetrive the premium for the customer.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePremium"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePremium_gh.29.uk","parameters":[{"name":"insurancepremiumid","in":"path","description":"The INSURANCEPREMIUMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_premium"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_premium":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_premium_id","name","number"],"properties":{"insurance_premium_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePremium by id","description":"Delete InsurancePremium by id
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"InsurancePremium"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePremium_gh.29.uk","parameters":[{"name":"insurancepremiumid","in":"path","description":"The INSURANCEPREMIUMID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank-id","insurance_premium"],"properties":{"bank-id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insurance_premium":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["insurance_premium_id","name","number"],"properties":{"insurance_premium_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"bank-id":{"type":"string"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/consumers/{consumerid}/active-rate-limits":{"get":{"tags":["Consumer"],"summary":"Get Active Rate Limits (Current)","description":"Get the active rate limits for a consumer at the current date/time. Returns the aggregated rate limits from all active records at this moment.
\nThis is a convenience endpoint that uses the current date/time automatically.
\nSee [here](/glossary#Rate Limiting) for more details on how rate limiting works.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nactive_at_date: active_at_date
\nactive_per_day_rate_limit: active_per_day_rate_limit
\nactive_per_hour_rate_limit: active_per_hour_rate_limit
\nactive_per_minute_rate_limit: active_per_minute_rate_limit
\nactive_per_month_rate_limit: active_per_month_rate_limit
\nactive_per_second_rate_limit: active_per_second_rate_limit
\nactive_per_week_rate_limit: active_per_week_rate_limit
\nconsidered_rate_limit_ids: considered_rate_limit_ids
\n","operationId":"OBPv6.0.0-getActiveRateLimitsNow","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["active_per_minute_rate_limit","active_per_hour_rate_limit","active_per_day_rate_limit","active_per_second_rate_limit","considered_rate_limit_ids","active_at_date","active_per_week_rate_limit","active_per_month_rate_limit"],"properties":{"active_at_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"active_per_second_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_day_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_week_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"considered_rate_limit_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"active_per_minute_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_month_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active_per_hour_rate_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"active_per_minute_rate_limit":{"type":"integer"},"active_per_hour_rate_limit":{"type":"integer"},"active_per_day_rate_limit":{"type":"integer"},"active_per_second_rate_limit":{"type":"integer"},"considered_rate_limit_ids":{"type":"array","items":{"type":"string"}},"active_at_date":{"type":"string","format":"date-time"},"active_per_week_rate_limit":{"type":"integer"},"active_per_month_rate_limit":{"type":"integer"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/system-dynamic-entities/{dynamicentityid}/backup":{"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Backup System Level Dynamic Entity","description":"Create a backup copy of a system level DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nThis endpoint creates a backup of the dynamic entity definition and all its data records.
\nThe backup entity will be named with a _BAK suffix (e.g. my_entity_BAK).
\nIf a backup with that name already exists, _BAK2, _BAK3 etc. will be used.
The calling user will be granted CanGetDynamicEntity_<BackupEntityName> on the newly created backup entity.
For more information see here
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-backupSystemDynamicEntity","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dynamic_entity_id","has_community_access","entity_name","personal_requires_role","user_id","has_public_access","schema","has_personal_entity"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"entity_name":{"type":"string"},"personal_requires_role":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"},"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}}}}}},"has_personal_entity":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/banks/{bankid}/customers/{customerid}/kyc_media/{kycmediaid}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Media","description":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","operationId":"OBPv2.0.0-addKycMedia","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}},{"name":"kycmediaid","in":"path","description":"The KYCMEDIAID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","customer_number","relates_to_kyc_check_id","date","relates_to_kyc_document_id","type"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"relates_to_kyc_document_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relates_to_kyc_check_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"url":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","type","bank_id","customer_number","date","relates_to_kyc_document_id","id","relates_to_kyc_check_id","url"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"relates_to_kyc_document_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relates_to_kyc_check_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/banks/{bankid}/accounts/{accountid}/account":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Account by Id (Core)","description":"Information returned about the account specified by ACCOUNT_ID:
\nThis call returns the owner view and requires access to that view.
\nThis v6.0.0 version returns account_id instead of id for consistency with other v6.0.0 endpoints.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\n\nproduct_code: 1234BW
\nscheme: OBP
\n\n","operationId":"OBPv6.0.0-getCoreAccountByIdV600","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["views_basic","product_code","bank_id","label","number","account_routings","account_id","balance"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"views_basic":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"views_basic":{"type":"array","items":{"type":"string"}},"product_code":{"type":"string"},"bank_id":{"type":"string"},"label":{"type":"string"},"number":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/users/current/logout-link":{"get":{"tags":["User"],"summary":"Get Logout Link","description":"Get the Logout Link
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nlink:
\n","operationId":"OBPv4.0.0-getLogoutLink","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["link"],"properties":{"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"link":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user_customer_links/{usercustomerlinkid}":{"delete":{"tags":["Customer"],"summary":"Delete User Customer Link","description":"Delete User Customer Link by USER_CUSTOMER_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteUserCustomerLink","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"usercustomerlinkid","in":"path","description":"The USERCUSTOMERLINKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/owner/transaction-request-types/{hold}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (HOLD)","description":"Create a transaction request to move funds from the account to its Holding Account.
\nIf the Holding Account does not exist, it will be created automatically.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nHOLD: HOLD
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv6.0.0-createTransactionRequestHold","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"hold","in":"path","description":"The HOLD identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","description"],"properties":{"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"description":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers at Bank","description":"Get Customers at Bank.
\nReturns a list of all customers at the specified bank.
\nDate Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
Query Parameters:
\n- limit: Maximum number of customers to return (optional)
\n- offset: Number of customers to skip for pagination (optional)
\n- sort_direction: Sort direction - ASC or DESC (optional)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCustomersAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Customer","Person"],"summary":"Create Customer","description":"The Customer resource stores the customer number, legal name, email, phone number, date of birth, relationship status,
\neducation attained, a url for a profile image, KYC status, credit rating, credit limit, and other customer information.
Required Fields:
\n- legal_name: The customer's full legal name
\n- mobile_phone_number: The customer's mobile phone number
Optional Fields:
\n- customer_number: If not provided, a random number will be generated
\n- email: Customer's email address
\n- face_image: Customer's face image (url and date)
\n- date_of_birth: Customer's date of birth in YYYY-MM-DD format
\n- relationship_status: Customer's relationship status
\n- dependants: Number of dependants (must match the length of dob_of_dependants array)
\n- dob_of_dependants: Array of dependant birth dates in YYYY-MM-DD format
\n- credit_rating: Customer's credit rating (rating and source)
\n- credit_limit: Customer's credit limit (currency and amount)
\n- highest_education_attained: Customer's highest education level
\n- employment_status: Customer's employment status
\n- kyc_status: Know Your Customer verification status (true/false). Default: false
\n- last_ok_date: Last verification date
\n- title: Customer's title (e.g., Mr., Mrs., Dr.)
\n- branch_id: Associated branch identifier
\n- name_suffix: Customer's name suffix (e.g., Jr., Sr.)
\n- customer_type: Type of customer - INDIVIDUAL (default), CORPORATE, or SUBSIDIARY
\n- parent_customer_id: For SUBSIDIARY customers, the customer_id of the parent CORPORATE customer
Date Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants must be provided in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
\nThe dates are strictly validated and must be valid calendar dates.
\nDates are stored with time set to midnight (00:00:00) UTC for consistency.
Validations:
\n- customer_number cannot contain :::: characters
\n- customer_number must be unique for the bank
\n- The number of dependants must equal the length of the dob_of_dependants array
\n- date_of_birth must be in valid YYYY-MM-DD format if provided
\n- Each date in dob_of_dependants must be in valid YYYY-MM-DD format
Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndate: 2020-01-27
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nbranch_id: DERBY6
\n\n\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nname_suffix: Sr
\n\nrelationship_status: single
\ntitle: Dr.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-createCustomer","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["relationship_status","name_suffix","highest_education_attained","credit_limit","date_of_birth","title","last_ok_date","face_image","dob_of_dependants","credit_rating","email","customer_number","kyc_status","customer_type","legal_name","branch_id","employment_status","mobile_phone_number","dependants"],"properties":{"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"relationship_status":{"type":"string"},"name_suffix":{"type":"string"},"highest_education_attained":{"type":"string"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"date_of_birth":{"type":"string","format":"date-time"},"title":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"email":{"type":"string"},"customer_number":{"type":"string"},"kyc_status":{"type":"boolean"},"customer_type":{"type":"string"},"legal_name":{"type":"string"},"branch_id":{"type":"string"},"employment_status":{"type":"string"},"mobile_phone_number":{"type":"string"},"dependants":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user-invitations/{secretlink}":{"get":{"tags":["User-Invitation"],"summary":"Get User Invitation","description":"Get User Invitation
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nSECRET_LINK: SECRET_LINK
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","operationId":"OBPv4.0.0-getUserInvitation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"secretlink","in":"path","description":"The SECRETLINK identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["email","purpose","first_name","country","status","company","last_name"],"properties":{"first_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"purpose":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/atms/{atmid}/accessibility-features":{"put":{"tags":["ATM"],"summary":"Update ATM Accessibility Features","description":"Update ATM Accessibility Features.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n","operationId":"OBPv4.0.0-updateAtmAccessibilityFeatures","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibility_features"],"properties":{"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"accessibility_features":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibility_features","atm_id"],"properties":{"accessibility_features":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"accessibility_features":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/customers/{customerid}/kyc_media":{"get":{"tags":["KYC","Customer"],"summary":"Get KYC Media for a customer","description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","operationId":"OBPv2.0.0-getKycMedia","parameters":[{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["medias"],"properties":{"medias":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_id","type","bank_id","customer_number","date","relates_to_kyc_document_id","id","relates_to_kyc_check_id","url"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"relates_to_kyc_document_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relates_to_kyc_check_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/api-collections/featured/{apicollectionid}":{"put":{"tags":["Api-Collection","API"],"summary":"Update Featured Api Collection","description":"Update the sort order of a featured API collection.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfeatured_api_collection_id: 9uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nsort_order: 1
\n","operationId":"OBPv6.0.0-updateFeaturedApiCollection","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sort_order"],"properties":{"sort_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"sort_order":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["featured_api_collection_id","api_collection_id","sort_order"],"properties":{"featured_api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"sort_order":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"featured_api_collection_id":{"type":"string"},"api_collection_id":{"type":"string"},"sort_order":{"type":"integer"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Api-Collection","API"],"summary":"Delete Featured Api Collection","description":"Remove an API Collection from the featured list.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteFeaturedApiCollection","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"},"403":{"description":"Forbidden"},"200":{"description":"Successful operation"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/views/{viewid}/balances":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Account Balances by BANK_ID through the VIEW_ID","description":"Get the Balances for the Account specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","operationId":"OBPv5.1.0-getBankAccountsBalancesThroughView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","label","balances","account_routings","account_id"],"properties":{"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","address"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balances":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","amount","currency"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/oidc/clients/verify":{"post":{"tags":["OIDC","Consumer","OAuth"],"summary":"Verify OIDC Client","description":"Verifies an OIDC/OAuth2 client's credentials.
\nReturns valid: true if the client_id and client_secret match an active consumer.
\nAlso returns the consumer_id and redirect_uris for use by the OIDC provider.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nclient_id: client_id
\nclient_secret: client_secret
\nJSON response body fields:
\nvalid: valid
\nclient_id: client_id
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nredirect_uris: redirect_uris
\n","operationId":"OBPv6.0.0-verifyOidcClient","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["client_id","client_secret"],"properties":{"client_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"client_secret":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["client_id","redirect_uris","valid","consumer_id"],"properties":{"client_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_uris":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"valid":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"client_id":{"type":"string"},"redirect_uris":{"type":"array","items":{"type":"string"}},"valid":{"type":"boolean"},"consumer_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/accounts/{accountid}":{"get":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Get Bank Account By Id","description":"Get Bank Account
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEndpointProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"url_pattern",\n "value":"http://obp_mock//accounts/{account_id}"\n },\n {\n "key":"http_method",\n "value":"GET"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID","parameters":[{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"balance":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/dynamic-registration/consumers":{"post":{"tags":["Directory","Consumer"],"summary":"Create a Consumer(Dynamic Registration)","description":"Create a Consumer with full certificate validation (mTLS access) - Recommended for PSD2/Berlin Group compliance.
\nThis endpoint provides secure, validated consumer registration unlike the standard /management/consumers endpoint.
How it works (for comprehension flow):
\nPSD2-CERT header in PEM formatCertificate Validation (CRITICAL SECURITY DIFFERENCE from regular creation):
\n[YES] JWT Signature Verification: JWT must be signed with certificate's private key - proves TPP owns the certificate
\n[YES] Regulated Entity Check: Certificate must match a pre-registered Regulated Entity in the database
\n[YES] Certificate Binding: Certificate is permanently bound to the consumer at creation time
\n[YES] CA Validation: Certificate chain can be validated against trusted root CAs during API requests
\n[YES] PSD2 Compliance: Meets EU regulatory requirements for TPP registration
Security benefits vs regular consumer creation:
\n| Feature | Regular Creation | Dynamic Registration |
|---|---|---|
| Certificate validation | [NO] None | [YES] Full validation |
| Regulated Entity check | [NO] Not required | [YES] Required |
| JWT signature proof | [NO] Not required | [YES] Required (proves private key possession) |
| Self-signed certs | [YES] Accepted | [NO] Rejected |
| PSD2 compliant | [NO] No | [YES] Yes |
| Rogue TPP prevention | [NO] No | [YES] Yes |
Prerequisites:
\n1. TPP must be registered as a Regulated Entity with their certificate
\n2. Certificate must be provided in PSD2-CERT request header (PEM format)
\n3. JWT must be signed with the private key corresponding to the certificate
\n4. Trust store must be configured with trusted root CAs
JWT Payload Structure:
\nMinimal:
\n{ "description":"TPP Application Description" }\nFull:
\n{\n "description": "Payment Initiation Service",\n "app_name": "Tesobe GmbH",\n "app_type": "Confidential",\n "developer_email": "contact@tesobe.com",\n "redirect_url": "https://tpp.example.com/callback"\n}\nNote: JWT must be signed with the private key that corresponds to the public key in the certificate sent via PSD2-CERT header.
Certificate Information Extraction:
\nThe endpoint automatically extracts information from the certificate:
\n- Common Name (CN) → used as app_name if not provided in JWT
\n- Email Address → used as developer_email if not provided
\n- Organization (O) → used as company
\n- Certificate validity period
\n- Issuer information
Configuration Required:
\n- truststore.path.tpp_signature - Path to trust store for CA validation
\n- truststore.password.tpp_signature - Trust store password
\n- Regulated Entity must be pre-registered with certificate public key
Error Scenarios:
\n- JWT signature invalid → PostJsonIsNotSigned (400)
\n- Certificate not in Regulated Entity registry → RegulatedEntityNotFoundByCertificate (400)
\n- Invalid JWT format → InvalidJsonFormat (400)
\n- Missing PSD2-CERT header → Signature verification fails
This is the SECURE way to register consumers for production PSD2/Berlin Group implementations.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-createConsumerDynamicRegistration","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"jwt":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/accounts/{accountid}/direct-debit":{"post":{"tags":["Direct-Debit","Account"],"summary":"Create Direct Debit (management)","description":"Create direct debit for an account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-createDirectDebitManagement","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_expires","date_starts","customer_id","counterparty_id","date_signed","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_signed":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_starts","customer_id","active","bank_id","counterparty_id","date_signed","direct_debit_id","date_expires","date_cancelled","account_id","user_id"],"properties":{"date_starts":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_cancelled":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"date_signed":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_expires":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"direct_debit_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_signed":{"type":"string","format":"date-time"},"direct_debit_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"date_cancelled":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/customer-account-links/{customeraccountlinkid}":{"get":{"tags":["Customer"],"summary":"Get Customer Account Link by Id","description":"Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","operationId":"OBPv5.0.0-getCustomerAccountLinkById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customeraccountlinkid","in":"path","description":"The CUSTOMERACCOUNTLINKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_account_link_id","customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_account_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Customer"],"summary":"Update Customer Account Link by Id","description":"Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","operationId":"OBPv5.0.0-updateCustomerAccountLinkById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customeraccountlinkid","in":"path","description":"The CUSTOMERACCOUNTLINKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["relationship_type"],"properties":{"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"relationship_type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_account_link_id","customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_account_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Customer"],"summary":"Delete Customer Account Link","description":"Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","operationId":"OBPv5.0.0-deleteCustomerAccountLinkById","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customeraccountlinkid","in":"path","description":"The CUSTOMERACCOUNTLINKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/atms/{atmid}/attributes":{"get":{"tags":["ATM","ATM-Attribute","Attribute"],"summary":"Get ATM Attributes","description":"Get ATM Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_attributes: atm_attributes
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-getAtmAttributes","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["atm_attributes"],"properties":{"atm_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"atm_attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["ATM","ATM-Attribute","Attribute"],"summary":"Create ATM Attribute","description":"Create ATM Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv5.1.0-createAtmAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"atmid","in":"path","description":"The ATMID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value","is_active","type"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","bank_id","name","atm_attribute_id","value","is_active","atm_id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"atm_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/transaction-request-types/{card}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (CARD)","description":"When using CARD, the payee is set in the request body .
\nMoney goes into the Counterparty in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCARD: CARD
\nJSON request body fields:
\namount: 10.12
\nbrand: Visa
\ncard: card
\ncard_number: 364435172576215
\ncard_type: Credit
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncvv: 123
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexpiry_month: 01
\nexpiry_year: 2023
\nname_on_card: SusanSmith
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestCard","parameters":[{"name":"card","in":"path","description":"The CARD identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","value","card","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"card":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["card_number","cvv","card_type","name_on_card","brand","expiry_month","expiry_year"],"properties":{"expiry_year":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"cvv":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"expiry_month":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"brand":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_on_card":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"card_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"card":{"type":"object","properties":{"card_number":{"type":"string"},"cvv":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"brand":{"type":"string"},"expiry_month":{"type":"string"},"expiry_year":{"type":"string"}}},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/dynamic-entities/{dynamicentityid}":{"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update My Dynamic Entity","description":"Update a Dynamic Entity that I created.
\nThis v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.
Request format:
\n{\n "entity_name": "customer_preferences",\n "has_personal_entity": true,\n "has_public_access": false,\n "has_community_access": false,\n "personal_requires_role": false,\n "schema": {\n "description": "User preferences updated",\n "required": ["theme"],\n "properties": {\n "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference"},\n "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"},\n "notifications_enabled": {"type": "boolean", "example": "true", "description": "Whether to send notifications"}\n }\n }\n}\nNote:
\n* The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
\n* Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
\n* Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
\n* Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
\n* Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
For more information see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv6.0.0-updateMyDynamicEntity","parameters":[{"name":"dynamicentityid","in":"path","description":"The DYNAMICENTITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","has_personal_entity","entity_name","has_public_access"],"properties":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"has_personal_entity":{"type":"boolean"},"entity_name":{"type":"string"},"has_public_access":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["schema","dynamic_entity_id","has_community_access","personal_requires_role","entity_name","has_personal_entity","user_id","has_public_access"],"properties":{"personal_requires_role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"entity_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_entity_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","required","properties"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["theme","language","notifications_enabled"],"properties":{"theme":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","maxLength","example"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"language":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["minLength","description","type","example","maxLength"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"minLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"maxLength":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"notifications_enabled":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example","description"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"has_public_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_community_access":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"has_personal_entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"schema":{"type":"object","properties":{"description":{"type":"string"},"required":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"properties":{"type":"object","properties":{"theme":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"maxLength":{"type":"integer"},"example":{"type":"string"}}},"language":{"type":"object","properties":{"minLength":{"type":"integer"},"description":{"type":"string"},"type":{"type":"string"},"example":{"type":"string"},"maxLength":{"type":"integer"}}},"notifications_enabled":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"},"description":{"type":"string"}}}}}}},"dynamic_entity_id":{"type":"string"},"has_community_access":{"type":"boolean"},"personal_requires_role":{"type":"boolean"},"entity_name":{"type":"string"},"has_personal_entity":{"type":"boolean"},"user_id":{"type":"string"},"has_public_access":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/banks/{bankid}/consents/{consentid}/account-access":{"put":{"tags":["Consent","Account Information Service (AIS)"],"summary":"Update Consent Account Access by CONSENT_ID","description":"This endpoint is used to update the Account Access of Consent.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-updateConsentAccountAccessByConsentId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["access"],"properties":{"access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"access":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"iban":{"type":"string"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/management/method_routings/{methodroutingid}":{"put":{"tags":["Method-Routing","API"],"summary":"Update MethodRouting","description":"Update a MethodRouting.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExplaination of Fields:
\nif bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\\d+"
\nIf connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
URL Parameters:
\n\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","operationId":"OBPv3.1.0-updateMethodRouting","parameters":[{"name":"methodroutingid","in":"path","description":"The METHODROUTINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_bank_id_exact_match","method_name","parameters","bank_id_pattern","connector_name"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id_pattern":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_bank_id_exact_match":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"connector_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["is_bank_id_exact_match","method_name","parameters","bank_id_pattern","method_routing_id","connector_name"],"properties":{"connector_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id_pattern":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_bank_id_exact_match":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"method_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"method_routing_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Method-Routing","API"],"summary":"Delete MethodRouting","description":"Delete a MethodRouting specified by METHOD_ROUTING_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteMethodRouting","parameters":[{"name":"methodroutingid","in":"path","description":"The METHODROUTINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/user_customer_links/users/{userid}":{"get":{"tags":["Customer"],"summary":"Get User Customer Links by User","description":"Get User Customer Links by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv4.0.0-getUserCustomerLinksByUserId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_customer_links"],"properties":{"user_customer_links":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_customer_link_id","customer_id","is_active","date_inserted","user_id"],"properties":{"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_inserted":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"user_customer_link_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"user_customer_links":{"type":"array","items":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"date_inserted":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products":{"get":{"tags":["Product"],"summary":"Get Products","description":"Returns information about the financial products offered by a bank specified by BANK_ID including:
\nThe combination of bank_id and product_code is unique.
\nCan filter with attributes name and values.
\nURL params example: /banks/some-bank-id/products?&limit=50&offset=1
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\n\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","operationId":"OBPv4.0.0-getProducts","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["products"],"properties":{"products":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["product_code","bank_id","meta","more_info_url","parent_product_code","description","name","terms_and_conditions_url"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"terms_and_conditions_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"parent_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/accounts":{"post":{"tags":["Account"],"summary":"Create Account (POST)","description":"Create Account at bank specified by BANK_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the POST body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nproduct_code: 1234BW
\nscheme: OBP
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv4.0.0-addAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","label","balance","branch_id","user_id"],"properties":{"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","label","balance","account_attributes","branch_id","account_id","user_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/customers/{customerid}":{"get":{"tags":["Customer"],"summary":"Get Customer by CUSTOMER_ID","description":"Gets the Customer specified by CUSTOMER_ID.
\nDate Format:
\nIn v6.0.0, date_of_birth and dob_of_dependants are returned in ISO 8601 date format: YYYY-MM-DD (e.g., "1990-05-15", "2010-03-20").
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","operationId":"OBPv6.0.0-getCustomerByCustomerId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","date_of_birth","customer_attributes","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status","last_ok_date"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"last_ok_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/account-applications/{accountapplicationid}":{"get":{"tags":["Account-Application","Account"],"summary":"Get Account Application by Id","description":"Get the Account Application.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","operationId":"OBPv3.1.0-getAccountApplication","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountapplicationid","in":"path","description":"The ACCOUNTAPPLICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","product_code","status","customer","date_of_application","account_application_id"],"properties":{"date_of_application":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"account_application_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"date_of_application":{"type":"string","format":"date-time"},"account_application_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Account-Application","Account"],"summary":"Update Account Application Status","description":"Update an Account Application status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","operationId":"OBPv3.1.0-updateAccountApplicationStatus","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountapplicationid","in":"path","description":"The ACCOUNTAPPLICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","product_code","status","customer","date_of_application","account_application_id"],"properties":{"date_of_application":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"account_application_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"date_of_application":{"type":"string","format":"date-time"},"account_application_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/consumers/{consumerid}/scope/{scopeid}":{"delete":{"tags":["Scope","Consumer"],"summary":"Delete Consumer Scope","description":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","operationId":"OBPv3.0.0-deleteScope","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}},{"name":"scopeid","in":"path","description":"The SCOPEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}/target-views/{targetviewid}":{"get":{"tags":["View-Custom","Account"],"summary":"Get Custom View","description":"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.
\nViews 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.
\nData: 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.
\nAction: 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.
\nMetadata:
\nTransaction 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).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nUser 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv5.1.0-getCustomView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"targetviewid","in":"path","description":"The TARGETVIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_permissions","hide_metadata_if_alias_used","description","is_public","metadata_view","name","alias","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["View-Custom","Account"],"summary":"Update Custom View","description":"Update an existing custom view on a bank account
\nUser 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.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv5.1.0-updateCustomView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"targetviewid","in":"path","description":"The TARGETVIEWID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_permissions","hide_metadata_if_alias_used","description","is_public","metadata_view","which_alias_to_use"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"which_alias_to_use":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["allowed_permissions","hide_metadata_if_alias_used","description","is_public","metadata_view","name","alias","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_permissions":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"is_public":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"hide_metadata_if_alias_used":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["View-Custom","Account"],"summary":"Delete Custom View","description":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-deleteCustomView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"targetviewid","in":"path","description":"The TARGETVIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/message-docs/{connector}/json-schema":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs as JSON Schema","description":"Returns message documentation as JSON Schema format for code generation in any language.
\nThis endpoint provides machine-readable schemas instead of just examples, making it ideal for:
\n- AI-powered code generation
\n- Automatic adapter creation in multiple languages
\n- Type-safe client generation with tools like quicktype
Supported Connectors:
\n- rabbitmq_vOct2024 - RabbitMQ connector message schemas
\n- rest_vMar2019 - REST connector message schemas
\n- akka_vDec2018 - Akka connector message schemas
\n- kafka_vMay2019 - Kafka connector message schemas (if available)
Code Generation Examples:
\nGenerate Scala code with Circe:
\ncurl https://api.../message-docs/rabbitmq_vOct2024/json-schema > schemas.json\nquicktype -s schema schemas.json -o Messages.scala --framework circe\nGenerate Python code:
\nquicktype -s schema schemas.json -o messages.py --lang python\nGenerate TypeScript code:
\nquicktype -s schema schemas.json -o messages.ts --lang typescript\nSchema Structure:
\nEach message includes:
\n- process - The connector method name (e.g., "obp.getAdapterInfo")
\n- description - Human-readable description of what the message does
\n- outbound_schema - JSON Schema for request messages (OBP-API -> Adapter)
\n- inbound_schema - JSON Schema for response messages (Adapter -> OBP-API)
All nested type definitions are included in the definitions section for reuse.
Authentication:
\nThis endpoint is publicly accessible (no authentication required) to facilitate adapter development.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-getMessageDocsJsonSchema","parameters":[{"name":"connector","in":"path","description":"The CONNECTOR identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}}}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/addresses":{"get":{"tags":["Customer","KYC"],"summary":"Get Customer Addresses","description":"Get the Addresses of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","operationId":"OBPv3.1.0-getCustomerAddresses","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","customer_id","tags","postcode","line_1","line_2","line_3","customer_address_id","state","status","insert_date","country_code","county"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"insert_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"tags":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"customer_address_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"country_code":{"type":"string"},"county":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/transactions/{transactionid}/metadata/where":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction where Tag","description":"Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
\nIt represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\nlongitude: -77.0364
\nprovider: ETHEREUM
\nuser:
\n\n","operationId":"OBPv1.2.1-getWhereTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["where"],"properties":{"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","date","latitude","user"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction where Tag","description":"Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateWhereTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["where"],"properties":{"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction where Tag","description":"Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addWhereTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["where"],"properties":{"where":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","description":"Deletes the where tag of the transaction TRANSACTION_ID made on view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionid","in":"path","description":"The TRANSACTIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.1.0/banks/{bankid}/transaction-types":{"put":{"tags":["Bank"],"summary":"Create Transaction Type at bank","description":"Create Transaction Types for the bank specified by BANK_ID:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nvalue: 5987953
\n","operationId":"OBPv2.1.0-createTransactionType","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","short_code","bank_id","summary","charge","id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"short_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bankId","charge","summary","shortCode","description","id"],"properties":{"shortCode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bankId":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bankId":{"type":"object","properties":{"value":{"type":"string"}}},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"},"shortCode":{"type":"string"},"description":{"type":"string"},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/api-products/{apiproductcode}/attributes/{apiproductattributeid}":{"get":{"tags":["API","Api-Product-Attribute"],"summary":"Get Api Product Attribute","description":"Get an Api Product Attribute by API_PRODUCT_ATTRIBUTE_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nAPI_PRODUCT_ATTRIBUTE_ID: API_PRODUCT_ATTRIBUTE_ID
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv6.0.0-getApiProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductattributeid","in":"path","description":"The APIPRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["API","Api-Product-Attribute"],"summary":"Update Api Product Attribute","description":"Update an Api Product Attribute.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_ATTRIBUTE_ID: API_PRODUCT_ATTRIBUTE_ID
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_product_attribute_id: api_product_attribute_id
\napi_product_code: api_product_code
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv6.0.0-updateApiProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductattributeid","in":"path","description":"The APIPRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","is_active","name"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","api_product_attribute_id","bank_id","type","is_active","name","api_product_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"api_product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"api_product_code":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["API","Api-Product-Attribute"],"summary":"Delete Api Product Attribute","description":"Delete an Api Product Attribute by API_PRODUCT_ATTRIBUTE_ID.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_PRODUCT_ATTRIBUTE_ID: API_PRODUCT_ATTRIBUTE_ID
\nAPI_PRODUCT_CODE: API_PRODUCT_CODE
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteApiProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductcode","in":"path","description":"The APIPRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"apiproductattributeid","in":"path","description":"The APIPRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/waiting-for-godot":{"get":{"tags":["API"],"summary":"Waiting For Godot","description":"Waiting For Godot
\nUses query parameter "sleep" in milliseconds.
\nFor instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nsleep_in_milliseconds: sleep_in_milliseconds
\n","operationId":"OBPv5.1.0-waitingForGodot","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["sleep_in_milliseconds"],"properties":{"sleep_in_milliseconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"sleep_in_milliseconds":{"type":"integer"}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}":{"post":{"tags":["Account"],"summary":"Update Account Label","description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nlabel: My Account
\nJSON response body fields:
\n\n","operationId":"OBPv4.0.0-updateAccountLabel","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["label"],"properties":{"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"label":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/corporate-customers/{customerid}/subsidiaries":{"get":{"tags":["Corporate-Customer","Customer"],"summary":"Get Corporate Customer Subsidiaries","description":"Get the subsidiary customers of a corporate customer.
\nReturns a list of customers whose parent_customer_id matches the specified CUSTOMER_ID.
\nThe specified customer must be of type CORPORATE or SUBSIDIARY.
Authentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ncustomer_type: INDIVIDUAL
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv6.0.0-getCorporateCustomerSubsidiaries","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customers"],"properties":{"customers":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","last_ok_date","date_of_birth","face_image","credit_limit","employment_status","email","customer_id","relationship_status","dob_of_dependants","bank_id","highest_education_attained","customer_number","customer_type","credit_rating","name_suffix","legal_name","title","branch_id","parent_customer_id","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"parent_customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string","format":"date-time"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"customer_type":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"parent_customer_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/accounts/{accountid}/views/{viewid}":{"get":{"tags":["Account","Account Information Service (AIS)","PSD2"],"summary":"Get Account by Id (Core) through the VIEW_ID","description":"Information returned about the account through VIEW_ID :
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nproduct_code: 1234BW
\nscheme: OBP
\n\n","operationId":"OBPv5.1.0-getCoreAccountByIdThroughView","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","views_basic","bank_id","label","balance","product_code","id","number"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"views_basic":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"views_basic":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"product_code":{"type":"string"},"id":{"type":"string"},"number":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/banks/{bankid}/accounts/{accountid}/account-access-requests/{accountaccessrequestid}/approval":{"post":{"tags":["Account-Access-Request"],"summary":"Approve Account Access Request","description":"Approve an Account Access Request (checker step in maker/checker workflow).
\nThe checker must be a different user than the maker (requestor). This enforces dual control / maker-checker separation.
\nOnly requests with status INITIATED can be approved.
\nOn approval, the system automatically grants the target user access to the specified view.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ACCESS_REQUEST_ID: ACCOUNT_ACCESS_REQUEST_ID
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncomment: comment
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-approveAccountAccessRequest","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"accountaccessrequestid","in":"path","description":"The ACCOUNTACCESSREQUESTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["comment"],"properties":{"comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"comment":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","checker_user_id","created","account_access_request_id","is_system_view","business_justification","bank_id","view_id","checker_comment","status","target_user_id","updated","account_id"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"checker_comment":{"type":"string"},"status":{"type":"string"},"target_user_id":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/{viewid}/other_accounts/{otheraccountid}/metadata/physical_location":{"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Physical Location","description":"Update geocoordinates of the counterparty's main location
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-updateCounterpartyPhysicalLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["physical_location"],"properties":{"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add physical location to other bank account","description":"Add geocoordinates of the counterparty's main location
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","operationId":"OBPv1.2.1-addCounterpartyPhysicalLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["physical_location"],"properties":{"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["longitude","latitude"],"properties":{"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["success"],"properties":{"success":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"success":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Physical Location","description":"Delete physical location of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"otheraccountid","in":"path","description":"The OTHERACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/my/consent-infos":{"get":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Get My Consents Info At Bank","description":"This endpoint gets the Consents that the current User created at bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_standard: api_standard
\n\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\n\n","operationId":"OBPv4.0.0-getConsentInfosByBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["consents"],"properties":{"consents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["created_by_user_id","api_standard","consumer_id","last_usage_date","last_action_date","consent_id","status","api_version"],"properties":{"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_usage_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_standard":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"last_action_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/api/popular-endpoints":{"get":{"tags":["Metric","API"],"summary":"Get Popular Endpoints","description":"Returns the operation IDs of the 50 most popular endpoints based on usage metrics.
\nThis endpoint is public and does not require authentication.
\nThe response contains a simple list of operation_id strings, ordered by popularity (most called first).
\nThis includes endpoints from all API standards: OBP, Berlin Group, UK Open Banking, STET, Polish API, etc.
\nExample operation_id formats:
\n* OBP: OBPv4.0.0-getBanks
\n* Berlin Group: BGv1.3-getAccountList
\n* UK Open Banking: UKv3.1-getAccounts
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\noperation_ids: operation_ids
\n","operationId":"OBPv6.0.0-getPopularApis","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_ids"],"properties":{"operation_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"operation_ids":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}}}},"/obp/v1.2.1/banks/{bankid}/accounts/{accountid}/views/{viewid}":{"delete":{"tags":["View-Custom","Account"],"summary":"Delete Custom View","description":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv1.2.1-deleteViewForBankAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/customers/{customerid}/accounts-minimal":{"get":{"tags":["Account"],"summary":"Get Accounts Minimal for a Customer","description":"Get Accounts Minimal by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","operationId":"OBPv4.0.0-getAccountsMinimalByCustomerId","parameters":[{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","view_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/my/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 List","description":"Get My test_daniel707 List.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCan do filter on the fields
\ne.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
\nWill do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new My test_daniel707.
\nDescription of this entity, can be markdown text.
\nProperty List:
\nMethodRouting settings example:
\n{\n "is_bank_id_exact_match":false,\n "method_name":"dynamicEntityProcess",\n "connector_name":"rest_vMar2019",\n "bank_id_pattern":".*",\n "parameters":[\n {\n "key":"entityName",\n "value":"test_daniel707"\n }\n {\n "key":"url",\n "value":"http://mydomain.com/xxx"\n }\n ]\n}\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-dynamicEntity_createMytest_daniel707_","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"integer"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707"],"properties":{"test_daniel707":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["test_daniel707_id","name","number"],"properties":{"test_daniel707_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer"}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/users/{userid}/auth-context":{"delete":{"tags":["User"],"summary":"Delete User's Auth Contexts","description":"Delete the Auth Contexts of a User specified by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-deleteUserAuthContexts","parameters":[{"name":"userid","in":"path","description":"The USERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/message-docs/{connector}/swagger2.0":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs Swagger","description":"This endpoint provides example message docs in swagger format.
\nIt is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
\nThat is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
\nOBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n","operationId":"OBPv3.1.0-getMessageDocsSwagger","parameters":[{"name":"connector","in":"path","description":"The CONNECTOR identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}}}},"/obp/v6.0.0/management/consumers/{consumerid}/call-counters":{"get":{"tags":["Consumer"],"summary":"Get Call Counts for Consumer","description":"Get the call counters (current usage) for a specific consumer. Shows how many API calls have been made and when the counters reset.
\nThis endpoint returns the current state of API rate limits across all time periods (per second, per minute, per hour, per day, per week, per month).
\nResponse Structure:
\nThe response always contains a consistent structure with all six time periods, regardless of whether rate limits are configured or active.
Each time period contains:
\n- calls_made: Number of API calls made in the current period (null if no data available)
\n- reset_in_seconds: Seconds until the counter resets (null if no data available)
\n- status: Current state of the rate limit for this period
Status Values:
\n- ACTIVE: Rate limit counter is active and tracking calls. Both calls_made and reset_in_seconds will have numeric values.
\n- NO_COUNTER: Key does not exist - the consumer has not made any API calls in this time period yet.
\n- EXPIRED: The rate limit counter has expired (TTL reached 0). The counter will be recreated on the next API call.
\n- REDIS_UNAVAILABLE: Cannot retrieve data from Redis. This indicates a system connectivity issue.
\n- DATA_MISSING: Unexpected error - period data is missing from the response. This should not occur under normal circumstances.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nper_day: 4000
\n\n\nper_month: 500
\nper_second: 1000
\nper_week: 50000
\n\ncalls_made: 50
\n\n","operationId":"OBPv6.0.0-getConsumerCallCounters","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["per_month","per_hour","per_week","per_second","per_minute","per_day"],"properties":{"per_week":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_second":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_month":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_day":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_minute":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"per_hour":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["calls_made","reset_in_seconds","status"],"properties":{"calls_made":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"reset_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"per_month":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_hour":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_week":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_second":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_minute":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}},"per_day":{"type":"object","properties":{"calls_made":{"type":"integer"},"reset_in_seconds":{"type":"integer"},"status":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/endpoint-mappings/{endpointmappingid}":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get Endpoint Mapping by Id","description":"Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-getEndpointMapping","parameters":[{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Endpoint-Mapping"],"summary":"Update Endpoint Mapping","description":"Update an Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","operationId":"OBPv4.0.0-updateEndpointMapping","parameters":[{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"],"properties":{"operation_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"request_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"response_mapping":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entity","field","query"],"properties":{"entity":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"field":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"query":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"endpoint_mapping_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Endpoint-Mapping"],"summary":"Delete Endpoint Mapping","description":"Delete a Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteEndpointMapping","parameters":[{"name":"endpointmappingid","in":"path","description":"The ENDPOINTMAPPINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/consumers/{consumerid}/consumer/rate-limits":{"post":{"tags":["Consumer"],"summary":"Create Rate Limits for a Consumer","description":"Create Rate Limits for a Consumer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_date: 1100-01-01T01:01:01.000Z
\n\n\n\n\n\n\nto_date: 1100-01-01T01:01:01.000Z
\napi_name: api_name
\n\nbank_id: gh.29.uk
\nJSON response body fields:
\ncreated_at: created_at
\nfrom_date: 1100-01-01T01:01:01.000Z
\n\n\n\n\n\n\nrate_limiting_id: rate_limiting_id
\nto_date: 1100-01-01T01:01:01.000Z
\nupdated_at: updated_at
\napi_name: api_name
\n\nbank_id: gh.29.uk
\n","operationId":"OBPv6.0.0-createCallLimits","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","per_second_call_limit","api_name","per_minute_call_limit","per_week_call_limit","per_day_call_limit","api_version","per_month_call_limit","per_hour_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"api_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_second_call_limit":{"type":"string"},"api_name":{"type":"string"},"per_minute_call_limit":{"type":"string"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"api_version":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_date","updated_at","rate_limiting_id","created_at","per_second_call_limit","api_name","per_minute_call_limit","per_week_call_limit","per_day_call_limit","api_version","per_month_call_limit","per_hour_call_limit","from_date"],"properties":{"per_month_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"rate_limiting_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_week_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_hour_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_second_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"from_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"api_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated_at":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"per_minute_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"per_day_call_limit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"rate_limiting_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"per_second_call_limit":{"type":"string"},"api_name":{"type":"string"},"per_minute_call_limit":{"type":"string"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"api_version":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/branches/{branchid}":{"get":{"tags":["Branch","Bank"],"summary":"Get Branch","description":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","operationId":"OBPv3.0.0-getBranch","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"branchid","in":"path","description":"The BRANCHID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accessibleFeatures","more_info","branch_type","name","bank_id","location","id","is_accessible","address","drive_up","branch_routing","meta","phone_number","lobby"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"branch_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_routing":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"drive_up":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["friday","monday","saturday","thursday","tuesday","wednesday","sunday"],"properties":{"sunday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"tuesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"wednesday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"monday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"friday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"thursday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"saturday":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"meta":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["license"],"properties":{"license":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","id"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"lobby":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["saturday","tuesday","monday","friday","sunday","wednesday","thursday"],"properties":{"sunday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"tuesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"wednesday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"monday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"friday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"thursday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"saturday":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["closing_time","opening_time"],"properties":{"closing_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"opening_time":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"accessibleFeatures":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"address":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["city","county","postcode","line_1","line_2","line_3","state","country_code"],"properties":{"city":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_2":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"state":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"postcode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"county":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"country_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_3":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"line_1":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"is_accessible":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.1.0/my/consumers":{"post":{"tags":["Consumer"],"summary":"Create a Consumer","description":"Create a Consumer (Authenticated access).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napp_name: appNameBank
\napp_type: Web
\ncompany: Tesobe GmbH
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nenabled: false
\nredirect_url: https://apisandbox.openbankproject.com
\nclient_certificate: client_certificate
\nlogo_url: logo_url
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","operationId":"OBPv5.1.0-createMyConsumer","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","logo_url","developer_email","client_certificate","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"client_certificate":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"client_certificate":{"type":"string"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","created_by_user","logo_url","developer_email","consumer_id","consumer_key","certificate_pem","certificate_info","created","company","redirect_url","description","app_type","app_name"],"properties":{"app_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_pem":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","email","provider_id","username","user_id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"provider_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"certificate_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles_info","subject_domain_name","not_before","issuer_domain_name","not_after"],"properties":{"subject_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_before":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"roles_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"issuer_domain_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"not_after":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"redirect_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"logo_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"company":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"developer_email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consumer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"app_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"created":{"type":"string","format":"date-time"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/webui_props/{webuipropname}":{"put":{"tags":["WebUi-Props"],"summary":"Create or Update WebUiProps","description":"Create or Update a WebUiProps.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThis endpoint is idempotent - it will create the property if it doesn't exist, or update it if it does.
\nThe property is identified by WEBUI_PROP_NAME in the URL path.
Explanation of Fields:
\nwebui_, contain only alphanumeric characters, underscore, and dot, not exceed 255 characters, and will be converted to lowercase)The line break and double quotations should be escaped, example:
\n\n{"name": "webui_some", "value": "this value\nhave "line break" and double quotations."}\n\nshould be escaped like this:
\n\n{"name": "webui_some", "value": "this value\\nhave \\"line break\\" and double quotations."}\n\nInsert image examples:
\n// set width=100 and height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}\n\n// only set height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}\n\n// only width=20%\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}\n\nURL Parameters:
\nWEBUI_PROP_NAME: WEBUI_PROP_NAME
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\n","operationId":"OBPv6.0.0-createOrUpdateWebUiProps","parameters":[{"name":"webuipropname","in":"path","description":"The WEBUIPROPNAME identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_ui_props_id","name","value"],"properties":{"web_ui_props_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["WebUi-Props"],"summary":"Delete WebUiProps","description":"Delete a WebUiProps specified by WEBUI_PROP_NAME.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe property name will be converted to lowercase before deletion.
\nReturns 204 No Content on successful deletion.
\nThis endpoint is idempotent - if the property does not exist, it still returns 204 No Content.
\nRequires the CanDeleteWebUiProps role.
\nURL Parameters:
\nWEBUI_PROP_NAME: WEBUI_PROP_NAME
\nJSON response body fields:
\n","operationId":"OBPv6.0.0-deleteWebUiProps","parameters":[{"name":"webuipropname","in":"path","description":"The WEBUIPROPNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/rate-limiting":{"get":{"tags":["API","Rate-Limits"],"summary":"Get Rate Limiting Info","description":"Get information about the Rate Limiting setup on this OBP Instance such as:
\nIs rate limiting enabled and active?
\nWhat backend is used to keep track of the API calls (e.g. REDIS).
Note: Rate limiting can be set at the Consumer level and also for anonymous calls.
\nSee the consumer rate limits / call limits endpoints.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nenabled: false
\nis_active: false
\n\ntechnology: technology1
\n","operationId":"OBPv3.1.0-getRateLimitingInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["enabled","is_active","technology","service_available"],"properties":{"enabled":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"technology":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"service_available":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"enabled":{"type":"boolean"},"is_active":{"type":"boolean"},"technology":{"type":"string"},"service_available":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.0.0/banks/{bankid}/adapter":{"get":{"tags":["API"],"summary":"Get Adapter Info for a bank","description":"Get basic information about the Adapter listening on behalf of this bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","operationId":"OBPv3.0.0-getAdapterInfoForBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date","git_commit","name","version"],"properties":{"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"git_commit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"git_commit":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/system/log-cache/trace":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Trace Level Log Cache","description":"Returns TRACE level logs from the system log cache.
\nThis endpoint supports pagination via the following optional query parameters:
\n* limit - Maximum number of log entries to return
\n* offset - Number of log entries to skip (for pagination)
Example: GET /system/log-cache/trace?limit=50&offset=100
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","operationId":"OBPv5.1.0-logCacheTraceEndpoint","responses":{"200":{"description":"Successful operation"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-endpoints/{dynamicendpointid}/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Dynamic Endpoint Host","description":"Update dynamic endpoint Host.
\nThe value can be obp_mock, dynamic_entity, or some service url.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-updateDynamicEndpointHost","parameters":[{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"host":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"host":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/banks/{bankid}/accounts/{accountid}/{viewid}/counterparties/{counterpartyid}":{"get":{"tags":["Counterparty","Account"],"summary":"Get Counterparty by Id for any account (Explicit)","description":"This is a management endpoint that gets information about any single explicitly created Counterparty on an Account / View specified by its COUNTERPARTY_ID",
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","operationId":"OBPv4.0.0-getCounterpartyByIdForAnyAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bespoke","created_by_user_id","other_account_routing_address","name","metadata","this_bank_id","other_bank_routing_scheme","currency","other_account_secondary_routing_address","counterparty_id","other_account_routing_scheme","description","other_bank_routing_address","other_branch_routing_scheme","this_account_id","other_account_secondary_routing_scheme","is_beneficiary","other_branch_routing_address","this_view_id"],"properties":{"other_account_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created_by_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_beneficiary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bespoke":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","key"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"key":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"other_bank_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_branch_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"metadata":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["private_alias","physical_location","url","public_alias","open_corporates_url","more_info","corporate_location","image_url"],"properties":{"public_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"physical_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"image_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"private_alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"more_info":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"corporate_location":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user","date","longitude","latitude"],"properties":{"user":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","id","username"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"username":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"longitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"latitude":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"open_corporates_url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"other_bank_routing_address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"this_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"other_account_secondary_routing_scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Counterparty","Account"],"summary":"Delete Counterparty for any account (Explicit)","description":"This is a management endpoint that enables the deletion of any specified Counterparty along with any related Metadata of that Counterparty.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n","operationId":"OBPv4.0.0-deleteCounterpartyForAnyAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"counterpartyid","in":"path","description":"The COUNTERPARTYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/management/dynamic-endpoints/{dynamicendpointid}":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Dynamic Endpoint","description":"Get a Dynamic Endpoint.
\nGet one DynamicEndpoint,
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-getDynamicEndpoint","parameters":[{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","dynamic_endpoint_id","swagger_string"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dynamic_endpoint_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"swagger_string":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["swagger","paths","info","definitions","schemes","host"],"properties":{"host":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"paths":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["/accounts","/accounts/{account_id}"],"properties":{"/accounts":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["post"],"properties":{"post":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["responses","consumes","operationId","summary","description","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["201"],"properties":{"201":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}},"/accounts/{account_id}":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["get"],"properties":{"get":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","consumes","operationId","responses","summary","produces"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"operationId":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"produces":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"consumes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"responses":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["200"],"properties":{"200":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","schema"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["$ref"],"properties":{"$ref":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}}}}}}}}}},"info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["title","version"],"properties":{"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"schemes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["s"],"properties":{"s":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"definitions":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["AccountName"],"properties":{"AccountName":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"properties":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","balance"],"properties":{"name":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","format","example"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"format":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"example":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"swagger":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Dynamic Endpoint","description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","operationId":"OBPv4.0.0-deleteDynamicEndpoint","parameters":[{"name":"dynamicendpointid","in":"path","description":"The DYNAMICENDPOINTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/my/api-collections/{apicollectionid}":{"put":{"tags":["Api-Collection"],"summary":"Update My Api Collection By API_COLLECTION_ID","description":"Update Api Collection for logged in user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","operationId":"OBPv5.1.0-updateMyApiCollection","parameters":[{"name":"apicollectionid","in":"path","description":"The APICOLLECTIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","api_collection_name","is_sharable"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"description":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["api_collection_id","api_collection_name","is_sharable","description","user_id"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_sharable":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"api_collection_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.2.0/banks/{bankid}/fx/{fromcurrencycode}/{tocurrencycode}":{"get":{"tags":["FX"],"summary":"Get Current FxRate","description":"Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
\nOBP may try different sources of FX rate information depending on the Connector in operation.
\nFor example we want to convert EUR => USD:
\nOBP will:
\n1st try - Connector (database, core banking system or external FX service)
\n2nd try part 1 - fallbackexchangerates/eur.json
\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
\n3rd try - Hardcoded map of FX rates.
![\"FX](\"https://user-images.githubusercontent.com/485218/60005085-1eded600-966e-11e9-96fb-798b102d9ad0.png\")
Public Access: This endpoint can be made publicly accessible (no authentication required) by setting the property apiOptions.getCurrentFxRateIsPublic=true in the props file.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nTO_CURRENCY_CODE: EUR
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\n\n\nto_currency_code: EUR
\n","operationId":"OBPv2.2.0-getCurrentFxRate","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"fromcurrencycode","in":"path","description":"The FROMCURRENCYCODE identifier","required":true,"schema":{"type":"string"}},{"name":"tocurrencycode","in":"path","description":"The TOCURRENCYCODE identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["effective_date","to_currency_code","from_currency_code","bank_id","inverse_conversion_value","conversion_value"],"properties":{"inverse_conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"effective_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"conversion_value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from_currency_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"to_currency_code":{"type":"string"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"conversion_value":{"type":"number"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/consumer/consent-requests/{consentrequestid}/{implicit}/consents":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2"],"summary":"Create Consent By CONSENT_REQUEST_ID (IMPLICIT)","description":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent cannot elevate the privileges logged in user already have.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","operationId":"OBPv5.0.0-createConsentByConsentRequestIdImplicit","parameters":[{"name":"consentrequestid","in":"path","description":"The CONSENTREQUESTID identifier","required":true,"schema":{"type":"string"}},{"name":"implicit","in":"path","description":"The IMPLICIT identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access","consent_request_id","consent_id","status","jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/config":{"get":{"tags":["API"],"summary":"Get API Configuration","description":"Returns information about:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nakka:
\n\n\n\n\n\n\n\n\nrequire_scopes_for_listed_roles: false
\n\n\nvalue: 5987953
\n\nremote_data_secret_matched: remote_data_secret_matched
\n","operationId":"OBPv3.1.0-config","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["elastic_search","scopes","akka","cache"],"properties":{"elastic_search":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["metrics","warehouse"],"properties":{"metrics":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["property","value"],"properties":{"property":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"warehouse":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","property"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"property":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"scopes":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["require_scopes_for_all_roles","require_scopes_for_listed_roles"],"properties":{"require_scopes_for_all_roles":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"require_scopes_for_listed_roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"akka":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["ports","remote_data_secret_matched","log_level"],"properties":{"ports":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","property"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"property":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"remote_data_secret_matched":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"log_level":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"cache":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["ttl_in_seconds","function_name"],"properties":{"ttl_in_seconds":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"function_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"elastic_search":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string"},"value":{"type":"string"}}}},"warehouse":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}}}},"scopes":{"type":"object","properties":{"require_scopes_for_all_roles":{"type":"boolean"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"akka":{"type":"object","properties":{"ports":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}},"remote_data_secret_matched":{"type":"boolean"},"log_level":{"type":"string"}}},"cache":{"type":"array","items":{"type":"object","properties":{"ttl_in_seconds":{"type":"integer"},"function_name":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/adapter":{"get":{"tags":["API"],"summary":"Get Adapter Info","description":"Get basic information about the Adapter.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbackend_messages: backend_messages
\ndate: 2020-01-27
\nerrorCode: errorCode
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\ntext:
\ntotal_duration: total_duration
\n\nduration: 5.123
\n","operationId":"OBPv5.0.0-getAdapterInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["git_commit","version","date","name","total_duration","backend_messages"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"backend_messages":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["source","text","status","errorCode","duration"],"properties":{"duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"text":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"errorCode":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"total_duration":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"version":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"git_commit":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"git_commit":{"type":"string"},"version":{"type":"string"},"date":{"type":"string","format":"date-time"},"name":{"type":"string"},"total_duration":{"type":"number"},"backend_messages":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"text":{"type":"string"},"status":{"type":"string"},"errorCode":{"type":"string"},"duration":{"type":"number"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/firehose/accounts/views/{viewid}":{"get":{"tags":["Account","Account-Firehose","FirehoseData"],"summary":"Get Firehose Accounts at Bank","description":"Get all Accounts at a Bank.
\nThis endpoint allows bulk access to all accounts at the specified bank.
\nRequires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role
\nReturns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions.
\nThe view specified must have is_firehose = true
\nFor VIEW_ID try 'owner' or 'firehose'
\nOptional request parameters for filtering by account attributes:
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1
To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be _timestamp_):
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\nvalue: 5987953
\n\n","operationId":"OBPv4.0.0-getFirehoseAccountsAtOneBank","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","account_rules","bank_id","owners","label","balance","number","id"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"owners":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["provider","display_name","id"],"properties":{"provider":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"display_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_rules":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}}}}}}}},"example":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"account_rules":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"id":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/roles-with-entitlement-counts":{"get":{"tags":["Role","Entitlement"],"summary":"Get Roles with Entitlement Counts","description":"Returns all available roles with the count of entitlements that use each role.
\nThis endpoint provides statistics about role usage across all banks by counting
\nhow many entitlements have been granted for each role.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nRequires the CanGetRolesWithEntitlementCountsAtAllBanks role.
\nJSON response body fields:
\nentitlement_count: entitlement_count
\n\nrole:
\nroles: CanCreateMyUser
\n","operationId":"OBPv6.0.0-getRolesWithEntitlementCountsAtAllBanks","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["roles"],"properties":{"roles":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["entitlement_count","role","requires_bank_id"],"properties":{"entitlement_count":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"requires_bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"entitlement_count":{"type":"integer"},"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.0.0/search/metrics":{"get":{"tags":["Metric","API","Old-Style"],"summary":"Search API Metrics via Elasticsearch","description":"Search the API calls made to this API instance via Elastic Search.
\nLogin is required.
\nCanSearchMetrics entitlement is required to search metrics data.
\nparameters:
\nesType - elasticsearch type
\nsimple query:
\nq - plain_text_query
\ndf - default field to search
\nsort - field to sort on
\nsize - number of hits returned, default 10
\nfrom - show hits starting from
\njson query:
\nsource - JSON_query_(URL-escaped)
\nexample usage:
\n/search/metrics/q=findThis
\nor:
\n/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
\nNote!!
\nThe whole JSON query string MUST be URL-encoded:
\netc..
\nOnly q, source and esType are passed to Elastic
\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nnone:
\n","operationId":"OBPv2.0.0-elasticSearchMetrics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{}}}},"example":{"type":"object","properties":{}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/banks/{bankid}/agents":{"get":{"tags":["Account"],"summary":"Get Agents at Bank","description":"Get Agents at Bank.
\nUser Authentication is Optional. The User need not be logged in.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nagents: agents
\nlegal_name: Eveline Tripman
\n","operationId":"OBPv5.1.0-getAgents","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agents"],"properties":{"agents":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_id","legal_name","agent_number"],"properties":{"agent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"agent_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Customer","Person"],"summary":"Create Agent","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nagent_number: 5987953
\ncurrency: EUR
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","operationId":"OBPv5.1.0-createAgent","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","legal_name","agent_number","mobile_phone_number"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"currency":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["agent_id","is_pending_agent","currency","bank_id","legal_name","agent_number","mobile_phone_number","is_confirmed_agent"],"properties":{"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_confirmed_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_pending_agent":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/my/account-access-requests":{"get":{"tags":["Account-Access-Request"],"summary":"Get My Account Access Requests","description":"Get Account Access Requests created by the current user (maker view).
\nNo special roles are required — a user can always see their own requests.
\nAuthentication is Required
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\naccount_access_request_id: account_access_request_id
\naccount_access_requests: account_access_requests
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbusiness_justification: business_justification
\nchecker_comment: checker_comment
\nchecker_user_id: checker_user_id
\n\nis_system_view: is_system_view
\nrequestor_user_id: requestor_user_id
\n\ntarget_user_id: target_user_id
\nupdated: updated
\nview_id: owner
\n","operationId":"OBPv6.0.0-getMyAccountAccessRequests","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access_requests"],"properties":{"account_access_requests":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["requestor_user_id","created","account_access_request_id","is_system_view","business_justification","bank_id","view_id","target_user_id","checker_user_id","status","updated","account_id","checker_comment"],"properties":{"requestor_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_system_view":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"checker_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"business_justification":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"updated":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"target_user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"created":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"checker_comment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"account_access_requests":{"type":"array","items":{"type":"object","properties":{"requestor_user_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"account_access_request_id":{"type":"string"},"is_system_view":{"type":"boolean"},"business_justification":{"type":"string"},"bank_id":{"type":"string"},"view_id":{"type":"string"},"target_user_id":{"type":"string"},"checker_user_id":{"type":"string"},"status":{"type":"string"},"updated":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"checker_comment":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-requests/{transactionrequestid}":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request","description":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-getTransactionRequest","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"transactionrequestid","in":"path","description":"The TRANSACTIONREQUESTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenge","status","end_date","charge","transaction_ids","from","details","start_date","id"],"properties":{"challenge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","allowed_attempts","id"],"properties":{"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/webui-props/{webuipropname}":{"get":{"tags":["WebUi-Props"],"summary":"Get WebUiProp by Name","description":"Get a single WebUiProp by name.
\nProperties with names starting with "webui_" can be stored in the database and managed via API.
\nData Sources:
\nExplicit WebUiProps (Database): Custom values created/updated via the API and stored in the database.
\nImplicit WebUiProps (Configuration File): Default values defined in the sample.props.template configuration file.
Response Fields:
\nname: The property namevalue: The property valuewebUiPropsId (optional): UUID for database props, omitted for config propssource: Either "database" (editable via API) or "config" (read-only from config file)Query Parameter:
\nactive (optional, boolean string, default: "false")active=false or omitted: Returns only explicit prop from the database (source="database")active=true: Returns explicit prop from database, or if not found, returns implicit (default) prop from configuration file (source="config")Examples:
\nGet database-stored prop only:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props/webui_api_explorer_url
Get database prop or fallback to default:
\nhttps://apisandbox.openbankproject.com/obp/v6.0.0/webui-props/webui_api_explorer_url?active=true
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nWEBUI_PROP_NAME: WEBUI_PROP_NAME
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n\n","operationId":"OBPv6.0.0-getWebUiProp","parameters":[{"name":"webuipropname","in":"path","description":"The WEBUIPROPNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["web_ui_props_id","source","name","value"],"properties":{"web_ui_props_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"source":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/obp/v5.0.0/banks/{bankid}/customers/customer-number-query/overview":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer Overview","description":"Gets the Customer Overview specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlabel: My Account
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\n\nrelationship_status: single
\nscheme: OBP
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\ncontract_code: contract_code
\ncontracts: contracts
\n\n\n","operationId":"OBPv5.0.0-getCustomerOverview","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","customer_attributes","dob_of_dependants","face_image","credit_limit","employment_status","email","customer_id","relationship_status","bank_id","last_ok_date","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","accounts","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"accounts":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","label","balance","branch_id","account_attributes","account_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","type","name","contract_code"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"contract_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/signal/channels/{channelname}":{"delete":{"tags":["AI-Agent","Signal","Signalling","Channel"],"summary":"Delete Signal Channel","description":"Signal channels provide short-lived, Redis-backed messaging designed for AI agent discovery and coordination, but usable by any authenticated OBP consumer.
\nMessages are ephemeral and will expire after the configured TTL (default 1 hour).
This endpoint deletes a signal channel and all its messages immediately.
\nAuthentication is Required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCHANNEL_NAME: CHANNEL_NAME
\nJSON response body fields:
\nchannel_name: channel_name
\ndeleted: deleted
\n","operationId":"OBPv6.0.0-deleteSignalChannel","parameters":[{"name":"channelname","in":"path","description":"The CHANNELNAME identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["channel_name","deleted"],"properties":{"channel_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"deleted":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"channel_name":{"type":"string"},"deleted":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/attribute-definitions/customer":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attribute Definition","description":"Get Customer Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-getCustomerAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","category","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Create or Update Customer Attribute Definition","description":"Create or Update Customer Attribute Definition
\nThe category field must be one of: Customer
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","operationId":"OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","description","is_active","name","category","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["can_be_seen_on_views","attribute_definition_id","description","is_active","bank_id","name","category","type","alias"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"attribute_definition_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"alias":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"can_be_seen_on_views":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/consumer/consent-requests/{consentrequestid}/{email}/consents":{"post":{"tags":["Consent","Account Information Service (AIS)","PSD2","VRP"],"summary":"Create Consent By CONSENT_REQUEST_ID (EMAIL)","description":"This endpoint continues the process of creating a Consent.
\nIt starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent cannot elevate the privileges of the logged in user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","operationId":"OBPv5.0.0-createConsentByConsentRequestIdEmail","parameters":[{"name":"consentrequestid","in":"path","description":"The CONSENTREQUESTID identifier","required":true,"schema":{"type":"string"}},{"name":"email","in":"path","description":"The EMAIL identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_access","consent_request_id","consent_id","status","jwt"],"properties":{"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_access":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["helper_info","bank_id","view_id","account_id"],"properties":{"helper_info":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_ids"],"properties":{"counterparty_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"view_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"consent_request_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v2.1.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{sandboxtan}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SANDBOX_TAN)","description":"When using SANDBOX_TAN, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.
A Transaction Request can have one of several states.
Transactions are modeled on items in a bank statement that represent the movement of money.
Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.
A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv2.1.0-createTransactionRequestSandboxTan","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"sandboxtan","in":"path","description":"The SANDBOXTAN identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","description","value"],"properties":{"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenge","status","end_date","charge","transaction_ids","from","details","start_date","id"],"properties":{"challenge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","allowed_attempts","id"],"properties":{"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v3.1.0/banks/{bankid}/customers/{customerid}/number":{"put":{"tags":["Customer"],"summary":"Update the number of a Customer","description":"Update the number of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-02-25T15:15:24.469Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","operationId":"OBPv3.1.0-updateCustomerNumber","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"customerid","in":"path","description":"The CUSTOMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["customer_number"],"properties":{"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"customer_number":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["dependants","dob_of_dependants","face_image","credit_limit","employment_status","email","last_ok_date","customer_id","relationship_status","bank_id","highest_education_attained","customer_number","credit_rating","name_suffix","legal_name","title","branch_id","date_of_birth","mobile_phone_number","kyc_status"],"properties":{"customer_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name_suffix":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"email":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"customer_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"highest_education_attained":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"dob_of_dependants":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date_of_birth":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"credit_rating":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rating","source"],"properties":{"rating":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"source":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"last_ok_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"employment_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"credit_limit":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"title":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"face_image":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["url","date"],"properties":{"url":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}}}}}},"dependants":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"relationship_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.1.0/management/banks/{bankid}/consents/{consentid}/created-by-user":{"put":{"tags":["Consent","Account Information Service (AIS)"],"summary":"Update Created by User of Consent by CONSENT_ID","description":"This endpoint is used to Update the User bound to a consent.
\nIn general we would not expect for a management user to set the User bound to a consent, but there may be
\nsome use cases where this workflow is useful.
If successful, the "Created by User ID" field in the OBP Consent table will be updated.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","operationId":"OBPv5.1.0-updateConsentUserIdByConsentId","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"consentid","in":"path","description":"The CONSENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["status","consent_id","jwt"],"properties":{"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"consent_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"jwt":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/accounts/{accountid}/{viewid}/transaction-request-types/{agentcashwithdrawal}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (AGENT_CASH_WITHDRAWAL)","description":"Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.
In case the from object is used, it means that the refund comes from the part that sent you a transaction.
\nIn the from object, you have two choices :
\n- Use bank_id and account_id fields if the other account is registered on the OBP-API
\n- Use the counterparty_id field in case the counterparty account is out of the OBP-API
In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
\n(This case is not managed by the OBP-API and require an external adapter)
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nAGENT_CASH_WITHDRAWAL: AGENT_CASH_WITHDRAWAL
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nagent_number: 5987953
\namount: 10.12
\nbank_id: gh.29.uk
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","operationId":"OBPv4.0.0-createTransactionRequestAgentCashWithDrawal","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}},{"name":"viewid","in":"path","description":"The VIEWID identifier","required":true,"schema":{"type":"string"}},{"name":"agentcashwithdrawal","in":"path","description":"The AGENTCASHWITHDRAWAL identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["future_date","value","charge_policy","description","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"charge_policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"example":{"type":"object","properties":{"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"description":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","challenges","status","end_date","attributes","charge","transaction_ids","from","details","start_date","id"],"properties":{"start_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","value"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"end_date":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string"},"format":{"type":"string"}}},"status":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","account_id"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"details":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to_sandbox_tan","value","to_transfer_to_phone","to_sepa","to_simple","to_counterparty","to_agent","description","to_transfer_to_account","to_sepa_credit_transfers","to_transfer_to_atm"],"properties":{"to_transfer_to_phone":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","to","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["description","message","from","value","to"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["date_of_birth","kyc_document","legal_name","mobile_phone_number"],"properties":{"date_of_birth":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"kyc_document":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["type","number"],"properties":{"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"legal_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"from":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["nickname","mobile_phone_number"],"properties":{"nickname":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"mobile_phone_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"message":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"to_counterparty":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["counterparty_id"],"properties":{"counterparty_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_agent":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"agent_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa_credit_transfers":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["instructedAmount","debtorAccount","creditorAccount","creditorName"],"properties":{"instructedAmount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"debtorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorAccount":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"creditorName":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_simple":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["otherBankRoutingAddress","otherAccountSecondaryRoutingAddress","otherBranchRoutingScheme","otherAccountRoutingScheme","otherAccountRoutingAddress","otherBankRoutingScheme","otherBranchRoutingAddress","otherAccountSecondaryRoutingScheme"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBankRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherAccountSecondaryRoutingScheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"otherBranchRoutingAddress":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sepa":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["iban"],"properties":{"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_transfer_to_account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["to","transfer_type","description","future_date","value"],"properties":{"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"future_date":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"to":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","account","bank_code","branch_number"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["number","iban"],"properties":{"number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"iban":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"bank_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"branch_number":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"transfer_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"to_sandbox_tan":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_id","bank_id"],"properties":{"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"charge":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["summary","value"],"properties":{"summary":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"transaction_ids":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"challenges":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["challenge_type","link","id","allowed_attempts","user_id"],"properties":{"allowed_attempts":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"link":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"challenge_type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v6.0.0/management/abac-rules-schema":{"get":{"tags":["ABAC"],"summary":"Get ABAC Rule Schema","description":"Get schema information about ABAC rule structure for building rule code.
\nThis endpoint returns schema information including:
\n- All 18 parameters available in ABAC rules
\n- Object types (User, Bank, Account, etc.) and their properties
\n- Available operators and syntax
\n- Example rules
This schema information is useful for:
\n- Building rule editors with auto-completion
\n- Validating rule syntax in frontends
\n- AI agents that help construct rules
\n- Dynamic form builders
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\navailable_operators: available_operators
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\nobject_types: object_types
\n\npolicy: policy
\nproperties: properties
\nrequired: required
\nrule_code: rule_code
\nrule_name: rule_name
\ntype:
\n","operationId":"OBPv6.0.0-getAbacRuleSchema","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["object_types","examples","notes","parameters","available_operators"],"properties":{"examples":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["rule_name","is_active","rule_code","policy","description"],"properties":{"rule_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"rule_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"policy":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"available_operators":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"object_types":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["properties","name","description"],"properties":{"properties":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","description"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"notes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}},"parameters":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["name","type","required","description","category"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"description":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"category":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"required":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"object_types":{"type":"array","items":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"}}}},"name":{"type":"string"},"description":{"type":"string"}}}},"examples":{"type":"array","items":{"type":"object","properties":{"rule_name":{"type":"string"},"is_active":{"type":"boolean"},"rule_code":{"type":"string"},"policy":{"type":"string"},"description":{"type":"string"}}}},"notes":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"category":{"type":"string"}}}},"available_operators":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v5.0.0/banks/{bankid}/accounts/{accountid}":{"put":{"tags":["Account","Onboarding"],"summary":"Create Account (PUT)","description":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the PUT body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","operationId":"OBPv5.0.0-createAccount","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"accountid","in":"path","description":"The ACCOUNTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["user_id","product_code","balance","label","branch_id","account_routings"],"properties":{"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"user_id":{"type":"string"},"product_code":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"label":{"type":"string"},"branch_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["account_routings","product_code","label","balance","account_attributes","branch_id","account_id","user_id"],"properties":{"account_attributes":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","account_attribute_id","product_instance_code","type","name"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_instance_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"branch_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_routings":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["address","scheme"],"properties":{"address":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"scheme":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}},"label":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"balance":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"amount":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"user_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"account_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/consumers/{consumerid}/scopes":{"get":{"tags":["Scope","Consumer"],"summary":"Get Scopes for Consumer","description":"Get all the scopes for an consumer specified by CONSUMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\nlist:
\n\n\n","operationId":"OBPv4.0.0-getScopes","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["list"],"properties":{"list":{"type":"object","required":["type","items"],"properties":{"type":{"type":"string"},"items":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scope_id","bank_id","role_name"],"properties":{"scope_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}}}}}}}},"example":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["Scope","Consumer"],"summary":"Create Scope for a Consumer","description":"Create Scope. Grant Role to Consumer.
\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","operationId":"OBPv4.0.0-addScope","parameters":[{"name":"consumerid","in":"path","description":"The CONSUMERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["bank_id","role_name"],"properties":{"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["scope_id","bank_id","role_name"],"properties":{"scope_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"role_name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/obp/v4.0.0/banks/{bankid}/products/{productcode}/attributes/{productattributeid}":{"get":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Get Product Attribute","description":"Get Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nGet one product attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-getProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productattributeid","in":"path","description":"The PRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","product_attribute_id","bank_id","type","name","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["Product","Product-Attribute","Attribute"],"summary":"Update Product Attribute","description":"Update Product Attribute.
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nUpdate one Product Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","operationId":"OBPv4.0.0-updateProductAttribute","parameters":[{"name":"bankid","in":"path","description":"The BANKID identifier","required":true,"schema":{"type":"string"}},{"name":"productcode","in":"path","description":"The PRODUCTCODE identifier","required":true,"schema":{"type":"string"}},{"name":"productattributeid","in":"path","description":"The PRODUCTATTRIBUTEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","type","name","is_active"],"properties":{"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","required":["type","properties"],"properties":{"type":{"type":"string"},"properties":{"type":"object","required":["value","product_code","product_attribute_id","bank_id","type","name","is_active"],"properties":{"name":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"is_active":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_attribute_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"product_code":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"bank_id":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"type":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}},"value":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}}}}},"example":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}}},"components":{"securitySchemes":{"DirectLogin":{"type":"apiKey","description":"Direct Login token authentication","name":"Authorization","in":"header"},"GatewayLogin":{"type":"apiKey","description":"Gateway Login token authentication","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","description":"OAuth2 authentication","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}}},"tags":[{"name":"Dynamic-Resource-Doc","description":"Operations related to Dynamic-Resource-Doc"},{"name":"Bank","description":"Operations related to Bank"},{"name":"Bank-Attribute","description":"Operations related to Bank-Attribute"},{"name":"Attribute","description":"Operations related to Attribute"},{"name":"Account-Public","description":"Operations related to Account-Public"},{"name":"Account","description":"Operations related to Account"},{"name":"PublicData","description":"Operations related to PublicData"},{"name":"User","description":"Operations related to User"},{"name":"Customer","description":"Operations related to Customer"},{"name":"_Odometer(gh.29.uk)","description":"Operations related to _Odometer(gh.29.uk)"},{"name":"Dynamic-Entity","description":"Operations related to Dynamic-Entity"},{"name":"Dynamic","description":"Operations related to Dynamic"},{"name":"Transaction-Request","description":"Operations related to Transaction-Request"},{"name":"Payment Initiation Service (PIS)","description":"Operations related to Payment Initiation Service (PIS)"},{"name":"PSD2","description":"Operations related to PSD2"},{"name":"Dynamic-Entity-Manage","description":"Operations related to Dynamic-Entity-Manage"},{"name":"API","description":"Operations related to API"},{"name":"AI-Agent","description":"Operations related to AI-Agent"},{"name":"Signal","description":"Operations related to Signal"},{"name":"Signalling","description":"Operations related to Signalling"},{"name":"Channel","description":"Operations related to Channel"},{"name":"_InsurancePremium(gh.29.uk)","description":"Operations related to _InsurancePremium(gh.29.uk)"},{"name":"_FooBar","description":"Operations related to _FooBar"},{"name":"Dynamic-Endpoint-Manage","description":"Operations related to Dynamic-Endpoint-Manage"},{"name":"User-Invitation","description":"Operations related to User-Invitation"},{"name":"KYC","description":"Operations related to KYC"},{"name":"Card","description":"Operations related to Card"},{"name":"Card-Attribute","description":"Operations related to Card-Attribute"},{"name":"Customer-Attribute","description":"Operations related to Customer-Attribute"},{"name":"Group","description":"Operations related to Group"},{"name":"Entitlement","description":"Operations related to Entitlement"},{"name":"_D-Entity1(gh.29.uk)","description":"Operations related to _D-Entity1(gh.29.uk)"},{"name":"Transaction-Metadata","description":"Operations related to Transaction-Metadata"},{"name":"Transaction","description":"Operations related to Transaction"},{"name":"_InsurancePolicy(gh.29.uk)","description":"Operations related to _InsurancePolicy(gh.29.uk)"},{"name":"Consent","description":"Operations related to Consent"},{"name":"Account Information Service (AIS)","description":"Operations related to Account Information Service (AIS)"},{"name":"Metric","description":"Operations related to Metric"},{"name":"OIDC","description":"Operations related to OIDC"},{"name":"Consumer","description":"Operations related to Consumer"},{"name":"OAuth","description":"Operations related to OAuth"},{"name":"_Customer_cars","description":"Operations related to _Customer_cars"},{"name":"_Sustrans","description":"Operations related to _Sustrans"},{"name":"Method-Routing","description":"Operations related to Method-Routing"},{"name":"_FishPort","description":"Operations related to _FishPort"},{"name":"Account-Application","description":"Operations related to Account-Application"},{"name":"Role","description":"Operations related to Role"},{"name":"System-Integrity","description":"Operations related to System-Integrity"},{"name":"Dynamic-Message-Doc","description":"Operations related to Dynamic-Message-Doc"},{"name":"Message-Doc","description":"Operations related to Message-Doc"},{"name":"Documentation","description":"Operations related to Documentation"},{"name":"Product","description":"Operations related to Product"},{"name":"Product-Attribute","description":"Operations related to Product-Attribute"},{"name":"Cache","description":"Operations related to Cache"},{"name":"System","description":"Operations related to System"},{"name":"Account-Metadata","description":"Operations related to Account-Metadata"},{"name":"_Test_daniel707","description":"Operations related to _Test_daniel707"},{"name":"Account-Access","description":"Operations related to Account-Access"},{"name":"View-Custom","description":"Operations related to View-Custom"},{"name":"OwnerViewRequired","description":"Operations related to OwnerViewRequired"},{"name":"Account-Attribute","description":"Operations related to Account-Attribute"},{"name":"Product-Collection","description":"Operations related to Product-Collection"},{"name":"Transaction-Attribute","description":"Operations related to Transaction-Attribute"},{"name":"Counterparty","description":"Operations related to Counterparty"},{"name":"JSON-Schema-Validation","description":"Operations related to JSON-Schema-Validation"},{"name":"_SimonCovid","description":"Operations related to _SimonCovid"},{"name":"Api-Collection","description":"Operations related to Api-Collection"},{"name":"ABAC","description":"Operations related to ABAC"},{"name":"_ObpActivity(obp.testing.01)","description":"Operations related to _ObpActivity(obp.testing.01)"},{"name":"Transaction-Request-Attribute","description":"Operations related to Transaction-Request-Attribute"},{"name":"Connector-Method","description":"Operations related to Connector-Method"},{"name":"Balance","description":"Operations related to Balance"},{"name":"Counterparty-Metadata","description":"Operations related to Counterparty-Metadata"},{"name":"_MarchHare(gh.29.uk)","description":"Operations related to _MarchHare(gh.29.uk)"},{"name":"ATM","description":"Operations related to ATM"},{"name":"User-Attribute","description":"Operations related to User-Attribute"},{"name":"Api-Product-Attribute","description":"Operations related to Api-Product-Attribute"},{"name":"Rate-Limits","description":"Operations related to Rate-Limits"},{"name":"View-System","description":"Operations related to View-System"},{"name":"Endpoint-Mapping","description":"Operations related to Endpoint-Mapping"},{"name":"Sandbox","description":"Operations related to Sandbox"},{"name":"_CovidAPIDays","description":"Operations related to _CovidAPIDays"},{"name":"Connector","description":"Operations related to Connector"},{"name":"Person","description":"Operations related to Person"},{"name":"Scope","description":"Operations related to Scope"},{"name":"Onboarding","description":"Operations related to Onboarding"},{"name":"Data-Warehouse","description":"Operations related to Data-Warehouse"},{"name":"Aggregate-Metrics","description":"Operations related to Aggregate-Metrics"},{"name":"_Test1","description":"Operations related to _Test1"},{"name":"VRP","description":"Operations related to VRP"},{"name":"PrivateData","description":"Operations related to PrivateData"},{"name":"Webhook","description":"Operations related to Webhook"},{"name":"Standing-Order","description":"Operations related to Standing-Order"},{"name":"Branch","description":"Operations related to Branch"},{"name":"WebUi-Props","description":"Operations related to WebUi-Props"},{"name":"Retail-Customer","description":"Operations related to Retail-Customer"},{"name":"Account-Access-Request","description":"Operations related to Account-Access-Request"},{"name":"Log-Cache","description":"Operations related to Log-Cache"},{"name":"Counterparty-Limits","description":"Operations related to Counterparty-Limits"},{"name":"Direct-Debit","description":"Operations related to Direct-Debit"},{"name":"Corporate-Customer","description":"Operations related to Corporate-Customer"},{"name":"Authentication-Type-Validation","description":"Operations related to Authentication-Type-Validation"},{"name":"Customer-Message","description":"Operations related to Customer-Message"},{"name":"Directory","description":"Operations related to Directory"},{"name":"ATM-Attribute","description":"Operations related to ATM-Attribute"},{"name":"Confirmation of Funds Service (PIIS)","description":"Operations related to Confirmation of Funds Service (PIIS)"},{"name":"DAuth","description":"Operations related to DAuth"},{"name":"Api-Product","description":"Operations related to Api-Product"},{"name":"Personal-Dynamic-Entity","description":"Operations related to Personal-Dynamic-Entity"},{"name":"Account-Firehose","description":"Operations related to Account-Firehose"},{"name":"Transaction-Firehose","description":"Operations related to Transaction-Firehose"},{"name":"FirehoseData","description":"Operations related to FirehoseData"},{"name":"FX","description":"Operations related to FX"},{"name":"Bank Accounts (Dynamic Endpoint)","description":"Operations related to Bank Accounts (Dynamic Endpoint)"},{"name":"Dynamic-Endpoint","description":"Operations related to Dynamic-Endpoint"},{"name":"Customer-Meeting","description":"Operations related to Customer-Meeting"},{"name":"Experimental","description":"Operations related to Experimental"},{"name":"Old-Style","description":"Operations related to Old-Style"}]}