Get Customer Account Links by ACCOUNT_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
links: links
relationship_type: Owner
","operationId":"OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAccountLinksJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{NEW_ACCOUNT_ID}":{"put":{"tags":["Account","Onboarding"],"summary":"Create Account (PUT)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
If 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.
If the PUT body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If 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.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
NEW_ACCOUNT_ID: NEW_ACCOUNT_ID
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
branch_id: DERBY6
currency: EUR
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
scheme: OBP
type:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
value: 5987953
product_instance_code: product_instance_code
","operationId":"OBPv5.0.0-createAccount","parameters":[{"in":"body","name":"body","description":"CreateAccountRequestJsonV500 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateAccountRequestJsonV500"}},{"in":"path","name":"NEW_ACCOUNT_ID","description":"new account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CreateAccountResponseJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/agents":{"post":{"tags":["Customer","Person"],"summary":"Create Agent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
agent_number: 5987953
currency: EUR
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
JSON response body fields:
agent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
agent_number: 5987953
bank_id: gh.29.uk
currency: EUR
is_confirmed_agent: is_confirmed_agent
is_pending_agent: is_pending_agent
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
","operationId":"OBPv5.1.0-createAgent","parameters":[{"in":"body","name":"body","description":"PostAgentJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAgentJsonV510"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AgentJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/agents/AGENT_ID":{"put":{"tags":["Customer","Person"],"summary":"Update Agent status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
AGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
BANK_ID: gh.29.uk
JSON response body fields:
agent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
agent_number: 5987953
bank_id: gh.29.uk
currency: EUR
is_confirmed_agent: is_confirmed_agent
is_pending_agent: is_pending_agent
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
","operationId":"OBPv5.1.0-updateAgentStatus","parameters":[{"in":"body","name":"body","description":"PutAgentJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutAgentJsonV510"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AgentJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/attribute-definitions/ATTRIBUTE_DEFINITION_ID/customer":{"delete":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Delete Customer Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
","operationId":"OBPv4.0.0-deleteCustomerAttributeDefinition","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/attribute-definitions/customer":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Attribute Definition
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
attributes: attribute value in form of (name, value)
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
","operationId":"OBPv4.0.0-getCustomerAttributeDefinition","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionsResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Create or Update Customer Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create or Update Customer Attribute Definition
The category field must be one of: Customer
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
","operationId":"OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition","parameters":[{"in":"body","name":"body","description":"AttributeDefinitionJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AttributeDefinitionJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/crm-events":{"get":{"tags":["Customer"],"summary":"Get CRM Events","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
actual_date: 2020-01-27
bank_id: gh.29.uk
customer_number: 5987953
id: d8839721-ad8f-45dd-9f78-2080414b93f9
scheduled_date: 2020-01-27
","operationId":"OBPv1.4.0-getCrmEvents","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CrmEventsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customer":{"get":{"tags":["Customer","Old-Style"],"summary":"Get customer for logged in user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Information about the currently authenticated user.
Authentication via OAuth is required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
relationship_status: single
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv1.4.0-getCustomer","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV140"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer","Old-Style"],"summary":"Add a customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add a customer linked to the currently authenticated user.
The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
This call may require additional permissions/role in the future.
For now the authenticated user can create at most one linked customer.
Dates need to be in the format 2013-01-21T23:08:00Z
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
Note: This call is depreciated in favour of v.2.0.0 createCustomer
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
branchId: branchId
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
nameSuffix: nameSuffix
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
relationship_status: single
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv1.4.0-addCustomer","parameters":[{"in":"body","name":"body","description":"CreateCustomerJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateCustomerJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV140"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customer-account-links":{"post":{"tags":["Customer","Account"],"summary":"Create Customer Account Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Link a Customer to a Account
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
","operationId":"OBPv5.0.0-createCustomerAccountLink","parameters":[{"in":"body","name":"body","description":"CreateCustomerAccountLinkJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateCustomerAccountLinkJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAccountLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID":{"delete":{"tags":["Customer"],"summary":"Delete Customer Account Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
","operationId":"OBPv5.0.0-deleteCustomerAccountLinkById","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Customer"],"summary":"Get Customer Account Link by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
","operationId":"OBPv5.0.0-getCustomerAccountLinkById","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAccountLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Customer"],"summary":"Update Customer Account Link by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
","operationId":"OBPv5.0.0-updateCustomerAccountLinkById","parameters":[{"in":"body","name":"body","description":"UpdateCustomerAccountLinkJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateCustomerAccountLinkJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAccountLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customer/{CUSTOMER_ID}/messages":{"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a message for the customer specified by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
from_department: Open Bank
from_person: Tom
message: 123456
JSON response body fields:
","operationId":"OBPv1.4.0-addCustomerMessage","parameters":[{"in":"body","name":"body","description":"AddCustomerMessageJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AddCustomerMessageJson"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customer/messages":{"get":{"tags":["Customer-Message","Customer"],"summary":"Get Customer Messages for all Customers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get messages for the logged in customer
Messages sent to the currently authenticated user.
Authentication via OAuth is required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
date: 2020-01-27
from_department: Open Bank
from_person: Tom
id: d8839721-ad8f-45dd-9f78-2080414b93f9
message: 123456
","operationId":"OBPv1.4.0-getCustomersMessages","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerMessagesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers at Bank.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv5.0.0-getCustomersAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONsV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer","Person"],"summary":"Create Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z
If kyc_status is not provided, it defaults to false.
Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
amount: 10.12
currency: EUR
date: 2020-01-27
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
url: http://www.example.com/id-docs/123/image.png
branch_id: DERBY6
customer_number: 5987953
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
name_suffix: Sr
relationship_status: single
title: Dr.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv5.0.0-createCustomer","parameters":[{"in":"body","name":"body","description":"PostCustomerJsonV500 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerJsonV500"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers-minimal":{"get":{"tags":["Customer","User"],"summary":"Get Customers Minimal at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers Minimal at Bank.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
","operationId":"OBPv5.0.0-getCustomersMinimalAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersMinimalJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserCustomerLinksNotFoundForUser"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}":{"get":{"tags":["Customer"],"summary":"Get Customer by CUSTOMER_ID","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
","operationId":"OBPv3.1.0-getCustomerByCustomerId","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerWithAttributesJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/address":{"post":{"tags":["Customer"],"summary":"Create Address","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create an Address for a Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
city:
country_code: 1254
tags: Create-My-User
JSON response body fields:
city:
country_code: 1254
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
insert_date: 2020-01-27
tags: Create-My-User
","operationId":"OBPv3.1.0-createCustomerAddress","parameters":[{"in":"body","name":"body","description":"PostCustomerAddressJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerAddressJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAddressJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/addresses":{"get":{"tags":["Customer","KYC"],"summary":"Get Customer Addresses","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Addresses of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
city:
country_code: 1254
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
insert_date: 2020-01-27
tags: Create-My-User
","operationId":"OBPv3.1.0-getCustomerAddresses","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAddressesJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/addresses/{CUSTOMER_ADDRESS_ID}":{"delete":{"tags":["Customer","KYC"],"summary":"Delete Customer Address","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
","operationId":"OBPv3.1.0-deleteCustomerAddress","parameters":[{"in":"path","name":"CUSTOMER_ADDRESS_ID","description":"the customer address id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Customer"],"summary":"Update the Address of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
city:
country_code: 1254
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
insert_date: 2020-01-27
tags: Create-My-User
","operationId":"OBPv3.1.0-updateCustomerAddress","parameters":[{"in":"body","name":"body","description":"PostCustomerAddressJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerAddressJsonV310"}},{"in":"path","name":"CUSTOMER_ADDRESS_ID","description":"the customer address id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAddressJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/attribute":{"post":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Create Customer Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Customer Attribute
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
JSON response body fields:
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
","operationId":"OBPv4.0.0-createCustomerAttribute","parameters":[{"in":"body","name":"body","description":"CustomerAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CustomerAttributeJsonV400"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/attributes":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attributes","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Attributes
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
","operationId":"OBPv4.0.0-getCustomerAttributes","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAttributesResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/attributes/ATTRIBUTE_ID":{"get":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Get Customer Attribute By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Attribute By Id
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
","operationId":"OBPv4.0.0-getCustomerAttributeById","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/attributes/CUSTOMER_ATTRIBUTE_ID":{"put":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Update Customer Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Customer Attribute
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
","operationId":"OBPv4.0.0-updateCustomerAttribute","parameters":[{"in":"body","name":"body","description":"CustomerAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CustomerAttributeJsonV400"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/branch":{"put":{"tags":["Customer"],"summary":"Update the Branch of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the Branch of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerBranch","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerBranchJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerBranchJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/correlated-users":{"get":{"tags":["Customer"],"summary":"Get Correlated User Info by Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Correlated User Info by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
insert_date: 2020-01-27
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
provider: ETHEREUM
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
user_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
user_attributes: user_attributes
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
users: user list
value: 5987953
","operationId":"OBPv4.0.0-getCorrelatedUsersInfoByCustomerId","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAndUsersWithAttributesResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/credit-limit":{"put":{"tags":["Customer"],"summary":"Update the credit limit of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the credit limit of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerCreditLimit","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerCreditLimitJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerCreditLimitJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/credit-rating-and-source":{"put":{"tags":["Customer"],"summary":"Update the credit rating and source of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the credit rating and source of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerCreditRatingAndSource","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerCreditRatingAndSourceJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerCreditRatingAndSourceJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/customer-account-links":{"get":{"tags":["Customer"],"summary":"Get Customer Account Links by CUSTOMER_ID","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Account Links by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
links: links
relationship_type: Owner
","operationId":"OBPv5.0.0-getCustomerAccountLinksByCustomerId","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerAccountLinksJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/data":{"put":{"tags":["Customer"],"summary":"Update the other data of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the other data of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerData","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerDataJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerDataJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/email":{"put":{"tags":["Customer"],"summary":"Update the email of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an email of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerEmail","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerEmailJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerEmailJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/identity":{"put":{"tags":["Customer"],"summary":"Update the identity data of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the identity data of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerIdentity","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerIdentityJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerIdentityJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_check/{KYC_CHECK_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Check","security":[{"directLogin":[],"gatewayLogin":[]}],"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
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
how:
id: d8839721-ad8f-45dd-9f78-2080414b93f9
satisfied: false
","operationId":"OBPv2.0.0-addKycCheck","parameters":[{"in":"body","name":"body","description":"PostKycCheckJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycCheckJSON"}},{"in":"path","name":"KYC_CHECK_ID","description":"The kyc check id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycCheckJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_documents/{KYC_DOCUMENT_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Document","security":[{"directLogin":[],"gatewayLogin":[]}],"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.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
expiry_date: 2021-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
issue_date: 2020-01-27
type:
","operationId":"OBPv2.0.0-addKycDocument","parameters":[{"in":"body","name":"body","description":"PostKycDocumentJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycDocumentJSON"}},{"in":"path","name":"KYC_DOCUMENT_ID","description":"The kyc document id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycDocumentJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_media/{KYC_MEDIA_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Media","security":[{"directLogin":[],"gatewayLogin":[]}],"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
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
type:
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv2.0.0-addKycMedia","parameters":[{"in":"body","name":"body","description":"PostKycMediaJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycMediaJSON"}},{"in":"path","name":"KYC_MEDIA_ID","description":"The kyc media id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycMediaJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_statuses":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
ok: false
","operationId":"OBPv2.0.0-addKycStatus","parameters":[{"in":"body","name":"body","description":"PostKycStatusJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycStatusJSON"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycStatusJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/messages":{"get":{"tags":["Customer-Message","Customer"],"summary":"Get Customer Messages for a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get messages for the customer specified by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
date: 2020-01-27
from_department: Open Bank
from_person: Tom
id: d8839721-ad8f-45dd-9f78-2080414b93f9
message: 123456
transport: SMS
","operationId":"OBPv4.0.0-getCustomerMessages","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerMessagesJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a message for the customer specified by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
from_department: Open Bank
from_person: Tom
message: 123456
transport: SMS
JSON response body fields:
","operationId":"OBPv4.0.0-createCustomerMessage","parameters":[{"in":"body","name":"body","description":"CreateMessageJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateMessageJsonV400"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/mobile-number":{"put":{"tags":["Customer"],"summary":"Update the mobile number of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the mobile number of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerMobileNumber","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerMobilePhoneNumberJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerMobilePhoneNumberJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/number":{"put":{"tags":["Customer"],"summary":"Update the number of a Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the number of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-updateCustomerNumber","parameters":[{"in":"body","name":"body","description":"PutUpdateCustomerNumberJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutUpdateCustomerNumberJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/social_media_handles":{"get":{"tags":["Customer"],"summary":"Get Customer Social Media Handles","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get social media handles for a customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_number: 5987953
type:
","operationId":"OBPv2.0.0-getSocialMediaHandles","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SocialMediasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer"],"summary":"Create Customer Social Media Handle","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a customer social media handle for the customer specified by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
customer_number: 5987953
type:
JSON response body fields:
","operationId":"OBPv2.0.0-addSocialMediaHandle","parameters":[{"in":"body","name":"body","description":"SocialMediaJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SocialMediaJSON"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/tax-residence":{"post":{"tags":["Customer","KYC"],"summary":"Create Tax Residence","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
tax_number: 456
JSON response body fields:
tax_number: 456
","operationId":"OBPv3.1.0-createTaxResidence","parameters":[{"in":"body","name":"body","description":"PostTaxResidenceJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTaxResidenceJsonV310"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TaxResidenceV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/tax-residences":{"get":{"tags":["Customer","KYC"],"summary":"Get Tax Residences of Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
tax_number: 456
","operationId":"OBPv3.1.0-getTaxResidence","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TaxResidenceJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/tax_residencies/{TAX_RESIDENCE_ID}":{"delete":{"tags":["Customer","KYC"],"summary":"Delete Tax Residence","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
","operationId":"OBPv3.1.0-deleteTaxResidence","parameters":[{"in":"path","name":"TAX_RESIDENCE_ID","description":"the tax residence id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/attributes/CUSTOMER_ATTRIBUTE_ID":{"delete":{"tags":["Customer","Customer-Attribute","Attribute"],"summary":"Delete Customer Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Customer Attribute
CustomerAttributes are used to enhance the OBP Customer object with Bank specific entities.
Delete a Customer Attribute by its id.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
","operationId":"OBPv4.0.0-deleteCustomerAttribute","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/customer-number":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer by CUSTOMER_NUMBER","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customer specified by CUSTOMER_NUMBER.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_number: 5987953
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
","operationId":"OBPv3.1.0-getCustomerByCustomerNumber","parameters":[{"in":"body","name":"body","description":"PostCustomerNumberJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerNumberJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerWithAttributesJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/customer-number-query/overview":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer Overview","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customer Overview specified by customer_number and bank_code.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_number: 5987953
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
label: My Account
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
product_code: 1234BW
relationship_status: single
scheme: OBP
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
contract_code: contract_code
contracts: contracts
","operationId":"OBPv5.0.0-getCustomerOverview","parameters":[{"in":"body","name":"body","description":"PostCustomerOverviewJsonV500 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerOverviewJsonV500"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerOverviewJsonV500"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/customer-number-query/overview-flat":{"post":{"tags":["Customer","KYC"],"summary":"Get Customer Overview Flat","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customer Overview Flat specified by customer_number and bank_code.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_number: 5987953
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
bank_id: gh.29.uk
branch_id: DERBY6
contract_code: contract_code
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date_of_birth: 2018-03-09
label: My Account
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
product_code: 1234BW
scheme: OBP
title: Dr.
type:
value: 5987953
branch_code: branch_code
cancellation_date: cancellation_date
contract_code: contract_code
contracts: contracts
form_of_payment: form_of_payment
instrument_status_code: instrument_status_code
instrument_status_definition: instrument_status_definition
interest_amount: interest_amount
interest_rate: interest_rate
is_substituted: is_substituted
issuance_amount: issuance_amount
maturity_date: maturity_date
opening_date: opening_date
payment_method: payment_method
product_description: product_description
renewal_date: renewal_date
term: term
","operationId":"OBPv5.0.0-getCustomerOverviewFlat","parameters":[{"in":"body","name":"body","description":"PostCustomerOverviewJsonV500 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerOverviewJsonV500"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerOverviewFlatJsonV500"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/customers/legal-name":{"post":{"tags":["Customer","KYC"],"summary":"Get Customers by Legal Name","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customers specified by Legal Name.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
legal_name: Eveline Tripman
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv5.1.0-getCustomersByLegalName","parameters":[{"in":"body","name":"body","description":"PostCustomerLegalNameJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerLegalNameJsonV510"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/meetings":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meetings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
keys:
name: ACCOUNT_MANAGEMENT_FEE
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
when: 2020-01-27
","operationId":"OBPv3.1.0-getMeetings","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MeetingsJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Create Meeting (video conference/call)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Meeting: Initiate a video conference/call with the bank.
The Meetings resource contains meta data about video/other conference sessions
provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
Login is required.
This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
date: 2020-01-27
name: ACCOUNT_MANAGEMENT_FEE
JSON response body fields:
bank_id: gh.29.uk
keys:
name: ACCOUNT_MANAGEMENT_FEE
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
when: 2020-01-27
","operationId":"OBPv3.1.0-createMeeting","parameters":[{"in":"body","name":"body","description":"CreateMeetingJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateMeetingJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/MeetingJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/meetings/{MEETING_ID}":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meeting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Meeting specified by BANK_ID / MEETING_ID
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
keys:
name: ACCOUNT_MANAGEMENT_FEE
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
when: 2020-01-27
","operationId":"OBPv3.1.0-getMeeting","parameters":[{"in":"path","name":"MEETING_ID","description":"the meeting id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MeetingJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/my/customers":{"get":{"tags":["Customer"],"summary":"Get My Customers at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
relationship_status: single
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv5.0.0-getMyCustomersAtBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/search/customers/mobile-phone-number":{"post":{"tags":["Customer","KYC"],"summary":"Get Customers by MOBILE_PHONE_NUMBER","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets the Customers specified by MOBILE_PHONE_NUMBER.
There are two wildcards often used in conjunction with the LIKE operator:
% - The percent sign represents zero, one, or multiple characters
_ - The underscore represents a single character
For 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.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
mobile_phone_number: +49 30 901820
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv4.0.0-getCustomersByCustomerPhoneNumber","parameters":[{"in":"body","name":"body","description":"PostCustomerPhoneNumberJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerPhoneNumberJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user-invitation":{"post":{"tags":["User-Invitation","KYC"],"summary":"Create User Invitation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create User Invitation.
This endpoint will send an invitation email to the developers, then they can use the link to create the obp user.
purpose filed only support:List(DEVELOPER, CUSTOMER).
You can customise the email details use the following webui props:
when purpose == DEVELOPER
webui_developer_user_invitation_email_subject
webui_developer_user_invitation_email_from
webui_developer_user_invitation_email_text
webui_developer_user_invitation_email_html_text
when purpose = == CUSTOMER
webui_customer_user_invitation_email_subject
webui_customer_user_invitation_email_from
webui_customer_user_invitation_email_text
webui_customer_user_invitation_email_html_text
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
JSON response body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
","operationId":"OBPv4.0.0-createUserInvitation","parameters":[{"in":"body","name":"body","description":"PostUserInvitationJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostUserInvitationJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserInvitationJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user-invitations":{"post":{"tags":["User-Invitation","KYC"],"summary":"Get User Invitation Information","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Invitation Information.
User Authentication is Optional. The User need not be logged in.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
secret_key: secret_key
JSON response body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
","operationId":"OBPv4.0.0-getUserInvitationAnonymous","parameters":[{"in":"body","name":"body","description":"PostUserInvitationAnonymousJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostUserInvitationAnonymousJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserInvitationJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user_customer_links":{"post":{"tags":["Customer","User"],"summary":"Create User Customer Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Link a User to a Customer
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
is_active: false
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
","operationId":"OBPv4.0.0-createUserCustomerLinks","parameters":[{"in":"body","name":"body","description":"CreateUserCustomerLinkJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserCustomerLinkJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserCustomerLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user_customer_links/USER_CUSTOMER_LINK_ID":{"delete":{"tags":["Customer"],"summary":"Delete User Customer Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete User Customer Link by USER_CUSTOMER_LINK_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
","operationId":"OBPv4.0.0-deleteUserCustomerLink","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user_customer_links/customers/{CUSTOMER_ID}":{"get":{"tags":["Customer"],"summary":"Get User Customer Links by Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Customer Links by CUSTOMER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
is_active: false
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
","operationId":"OBPv4.0.0-getUserCustomerLinksByCustomerId","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserCustomerLinksJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/user_customer_links/users/{USER_ID}":{"get":{"tags":["Customer"],"summary":"Get User Customer Links by User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Customer Links by USER_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
is_active: false
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
","operationId":"OBPv4.0.0-getUserCustomerLinksByUserId","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserCustomerLinksJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/FIREHOSE_BANK_ID/firehose/customers":{"get":{"tags":["Customer","FirehoseData"],"summary":"Get Firehose Customers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers that has a firehose View.
Allows bulk access to customers.
User must have the CanUseFirehoseAtAnyBank Role
Possible custom url parameters for pagination:
eg1:?limit=100&offset=0
URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.
eg2:?limit=100&offset=0&sort_direction=ASC
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
FIREHOSE_BANK_ID: FIREHOSE_BANK_ID
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
relationship_status: single
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv3.1.0-getFirehoseCustomers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers at Any Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers at Any Bank.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv4.0.0-getCustomersAtAnyBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONsV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers-minimal":{"get":{"tags":["Customer","User"],"summary":"Get Customers Minimal at Any Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers Minimal at Any Bank.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
","operationId":"OBPv4.0.0-getCustomersMinimalAtAnyBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersMinimalJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers/{CUSTOMER_ID}/kyc_checks":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Checks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
how:
id: d8839721-ad8f-45dd-9f78-2080414b93f9
satisfied: false
","operationId":"OBPv2.0.0-getKycChecks","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycChecksJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers/{CUSTOMER_ID}/kyc_documents":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Documents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
Get a list of documents that affirm the identity of the customer
Passport, driving licence etc.
User Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
expiry_date: 2021-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
issue_date: 2020-01-27
type:
","operationId":"OBPv2.0.0-getKycDocuments","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycDocumentsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers/{CUSTOMER_ID}/kyc_media":{"get":{"tags":["KYC","Customer"],"summary":"Get KYC Media for a customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
type:
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv2.0.0-getKycMedia","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycMediasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/customers/{CUSTOMER_ID}/kyc_statuses":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC statuses","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
ok: false
","operationId":"OBPv2.0.0-getKycStatuses","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycStatusesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/cascading/banks/{BANK_ID}/customers/{CUSTOMER_ID}":{"delete":{"tags":["Customer"],"summary":"Delete Customer Cascade","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Customer Cascade specified by CUSTOMER_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
","operationId":"OBPv4.0.0-deleteCustomerCascade","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/my/correlated-entities":{"get":{"tags":["Customer"],"summary":"Get Correlated Entities for the current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
correlated_entities: correlated_entities
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
insert_date: 2020-01-27
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
provider: ETHEREUM
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
user_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
user_attributes: user_attributes
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
users: user list
value: 5987953
","operationId":"OBPv4.0.0-getMyCorrelatedEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CorrelatedEntities"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/my/customers":{"get":{"tags":["Customer","User"],"summary":"Get My Customers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets all Customers that are linked to me.
Authentication via OAuth is required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
relationship_status: single
url: http://www.example.com/id-docs/123/image.png
","operationId":"OBPv5.0.0-getMyCustomersAtAnyBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/users":{"post":{"tags":["User","Onboarding"],"summary":"Create User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Creates OBP user.
No authorisation required.
Mimics current webform to Register.
Requires username(email), password, first_name, last_name, and email.
Validation checks performed:
- Password must meet strong password requirements (InvalidStrongPasswordFormat error if not)
- Username must be unique (409 error if username already exists)
- All required fields must be present in valid JSON format
Email validation behavior:
- Controlled by property 'authUser.skipEmailValidation' (default: false)
- When false: User is created with validated=false and a validation email is sent to the user's email address
- When true: User is created with validated=true and no validation email is sent
- Default entitlements are granted immediately regardless of validation status
Note: If email validation is required (skipEmailValidation=false), the user must click the validation link
in the email before they can log in, even though entitlements are already granted.
User Authentication is Optional. The User need not be logged in.
JSON request body fields:
first_name: Tom
last_name: Smith
password: passwordpasswordpassword
username: felixsmith
JSON response body fields:
bank_id: gh.29.uk
list:
provider: ETHEREUM
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
","operationId":"OBPv2.0.0-createUser","parameters":[{"in":"body","name":"body","description":"CreateUserJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v5.1.0/users/current/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers for Current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets all Customers that are linked to a User.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
","operationId":"OBPv3.0.0-getCustomersForUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersWithAttributesJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/users/current/customers/customer_ids":{"get":{"tags":["Customer","User"],"summary":"Get Customers for Current User (IDs only)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets all Customers Ids that are linked to a User.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2025-07-09T09:35:52.441Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
","operationId":"OBPv5.1.0-getCustomersForUserIdsOnly","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersWithAttributesJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorUserCustomerLinksNotFoundForUser":{"properties":{"message":{"type":"string","example":"OBP-30008: User Customer Link not found by USER_ID"}}},"PutAgentJsonV510":{"required":["is_pending_agent","is_confirmed_agent"],"properties":{"is_pending_agent":{"type":"boolean","example":"false"},"is_confirmed_agent":{"type":"boolean","example":"true"}}},"PutUpdateCustomerCreditLimitJsonV310":{"required":["credit_limit"],"properties":{"credit_limit":{"$ref":"#/definitions/AmountOfMoney"}}},"PostCustomerJsonV500":{"required":["mobile_phone_number","legal_name"],"properties":{"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+49 30 901820"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:54Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"PostKycCheckJSON":{"required":["customer_number","how","date","satisfied","staff_user_id","staff_name","comments"],"properties":{"customer_number":{"type":"string","example":"5987953"},"how":{"type":"string","example":"online_meeting"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"67876"},"staff_name":{"type":"string","example":"Simon"},"comments":{"type":"string","example":"String"}}},"PostUserInvitationAnonymousJsonV400":{"required":["secret_key"],"properties":{"secret_key":{"type":"integer","format":"int64","example":"5819479115482092878"}}},"PostCustomerPhoneNumberJsonV400":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"}}},"SocialMediaJSON":{"required":["date_activated","customer_number","date_added","type","handle"],"properties":{"date_activated":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"customer_number":{"type":"string","example":"5987953"},"date_added":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"PlaceholderString"},"handle":{"type":"string","example":"PlaceholderString"}}},"PostTaxResidenceJsonV310":{"required":["domain","tax_number"],"properties":{"domain":{"type":"string","example":"Enter some domain"},"tax_number":{"type":"string","example":"Enter some number"}}},"PostAgentJsonV510":{"required":["legal_name","mobile_phone_number","agent_number","currency"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"},"mobile_phone_number":{"type":"string","example":"+49 30 901820"},"agent_number":{"type":"string","example":"5987953"},"currency":{"type":"string","example":"EUR"}}},"PostCustomerAddressJsonV310":{"required":["city","line_2","state","tags","postcode","county","country_code","status","line_3","line_1"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"state":{"type":"string","example":"Brandenburg"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"status":{"type":"string","example":"OK"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"PostKycMediaJSON":{"required":["url","customer_number","date","relates_to_kyc_document_id","relates_to_kyc_check_id","type"],"properties":{"url":{"type":"string","example":"http://www.example.com/id-docs/123/image.png"},"customer_number":{"type":"string","example":"5987953"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"relates_to_kyc_document_id":{"type":"string","example":"123"},"relates_to_kyc_check_id":{"type":"string","example":"123"},"type":{"type":"string","example":"image"}}},"PostCustomerOverviewJsonV500":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"5987953"}}},"CreateUserJson":{"required":["first_name","email","username","last_name","password"],"properties":{"first_name":{"type":"string","example":"Simon"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"last_name":{"type":"string","example":"Redfern"},"password":{"type":"string","example":"String"}}},"PostKycStatusJSON":{"required":["customer_number","ok","date"],"properties":{"customer_number":{"type":"string","example":"5987953"},"ok":{"type":"boolean","example":"true"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"CreateCustomerAccountLinkJson":{"required":["customer_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"relationship_type":{"type":"string","example":"Owner"}}},"PutUpdateCustomerIdentityJsonV310":{"required":["legal_name","date_of_birth","title","name_suffix"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"title":{"type":"string","example":"Dr."},"name_suffix":{"type":"string","example":"Sr"}}},"PutUpdateCustomerMobilePhoneNumberJsonV310":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"+381631954907"}}},"PostCustomerLegalNameJsonV510":{"required":["legal_name"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"}}},"PutUpdateCustomerCreditRatingAndSourceJsonV310":{"required":["credit_rating","credit_source"],"properties":{"credit_rating":{"type":"string","example":"Good"},"credit_source":{"type":"string","example":"Bank"}}},"PutUpdateCustomerDataJsonV310":{"required":["highest_education_attained","employment_status","face_image","dependants","relationship_status"],"properties":{"highest_education_attained":{"type":"string","example":"Master"},"employment_status":{"type":"string","example":"worker"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"}}},"AttributeDefinitionJsonV400":{"required":["name","is_active","description","alias","can_be_seen_on_views","category","type"],"properties":{"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"alias":{"type":"string","example":"STRING"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"Customer"},"type":{"type":"string","example":"STRING"}}},"PutUpdateCustomerEmailJsonV310":{"required":["email"],"properties":{"email":{"type":"string","example":"marko@tesobe.com"}}},"CreateCustomerJson":{"required":["email","mobile_phone_number","customer_number","highest_education_attained","user_id","branchId","dob_of_dependants","date_of_birth","nameSuffix","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"branchId":{"type":"string","example":"DERBY6"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"nameSuffix":{"type":"string","example":"Sr"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:53Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"PostKycDocumentJSON":{"required":["number","customer_number","issue_date","type","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"12345"},"customer_number":{"type":"string","example":"5987953"},"issue_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"passport"},"issue_place":{"type":"string","example":"Berlin"},"expiry_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"PutUpdateCustomerNumberJsonV310":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"5987953"}}},"CreateAccountRequestJsonV500":{"required":["label","product_code"],"properties":{"branch_id":{"type":"string","example":"DERBY6"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"product_code":{"type":"string","example":"1234BW"}}},"CustomerAttributeJsonV400":{"required":["name","type","value"],"properties":{"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"PostCustomerNumberJsonV310":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"5987953"}}},"CreateMeetingJsonV310":{"required":["provider_id","creator","invitees","date","purpose_id"],"properties":{"provider_id":{"type":"string","example":"Chris"},"creator":{"$ref":"#/definitions/ContactDetailsJson"},"invitees":{"type":"array","items":{"$ref":"#/definitions/InviteeJson"}},"date":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"},"purpose_id":{"type":"string","example":"String, eg: onboarding"}}},"AddCustomerMessageJson":{"required":["message","from_department","from_person"],"properties":{"message":{"type":"string","example":"String"},"from_department":{"type":"string","example":"String"},"from_person":{"type":"string","example":"String"}}},"PutUpdateCustomerBranchJsonV310":{"required":["branch_id"],"properties":{"branch_id":{"type":"string","example":"123"}}},"UpdateCustomerAccountLinkJson":{"required":["relationship_type"],"properties":{"relationship_type":{"type":"string","example":"Owner"}}},"CreateUserCustomerLinkJson":{"required":["user_id","customer_id"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"CreateMessageJsonV400":{"required":["message","transport","from_department","from_person"],"properties":{"message":{"type":"string","example":"123456"},"transport":{"type":"string","example":"SMS"},"from_department":{"type":"string","example":"Open Bank"},"from_person":{"type":"string","example":"Tom"}}},"PostUserInvitationJsonV400":{"required":["first_name","email","country","purpose","company","last_name"],"properties":{"first_name":{"type":"string","example":"Tom"},"email":{"type":"string","example":"felixsmith@example.com"},"country":{"type":"string","example":"Germany"},"purpose":{"type":"string","example":"DEVELOPER"},"company":{"type":"string","example":"Tesobe GmbH"},"last_name":{"type":"string","example":"Smith"}}},"CustomerAddressesJsonV310":{"required":["addresses"],"properties":{"addresses":{"type":"array","items":{"$ref":"#/definitions/CustomerAddressJsonV310"}}}},"CustomersWithAttributesJsonV300":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerWithAttributesJsonV300"}}}},"CustomerJSONs":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV210"}}}},"UserCustomerLinksJson":{"required":["user_customer_links"],"properties":{"user_customer_links":{"type":"array","items":{"$ref":"#/definitions/UserCustomerLinkJson"}}}},"AgentJsonV510":{"required":["agent_number","mobile_phone_number","bank_id","currency","legal_name","is_confirmed_agent","is_pending_agent","agent_id"],"properties":{"agent_number":{"type":"string","example":"5987953"},"mobile_phone_number":{"type":"string","example":"+49 30 901820"},"bank_id":{"type":"string","example":"gh.29.uk"},"currency":{"type":"string","example":"EUR"},"legal_name":{"type":"string","example":"Eveline Tripman"},"is_confirmed_agent":{"type":"boolean","example":"false"},"is_pending_agent":{"type":"boolean","example":"true"},"agent_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"CustomerJsonV310":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:54Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"CustomerAccountLinksJson":{"required":["links"],"properties":{"links":{"type":"array","items":{"$ref":"#/definitions/CustomerAccountLinkJson"}}}},"KycCheckJSON":{"required":["customer_id","customer_number","bank_id","id","how","date","satisfied","staff_user_id","staff_name","comments"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"how":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"staff_name":{"type":"string","example":"PlaceholderString"},"comments":{"type":"string","example":"PlaceholderString"}}},"CustomerWithAttributesJsonV310":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","customer_attributes","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:54Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"CustomerMessagesJson":{"required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/definitions/CustomerMessageJson"}}}},"UserInvitationJsonV400":{"required":["first_name","email","country","purpose","company","last_name","status"],"properties":{"first_name":{"type":"string","example":"Tom"},"email":{"type":"string","example":"felixsmith@example.com"},"country":{"type":"string","example":"Germany"},"purpose":{"type":"string","example":"DEVELOPER"},"company":{"type":"string","example":"Tesobe GmbH"},"last_name":{"type":"string","example":"Smith"},"status":{"type":"string","example":""}}},"CustomerMessagesJsonV400":{"required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/definitions/CustomerMessageJsonV400"}}}},"CustomerJsonV140":{"required":["customer_id","email","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","date_of_birth","last_ok_date","employment_status","legal_name","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"String"},"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:53Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"KycDocumentsJSON":{"required":["documents"],"properties":{"documents":{"type":"array","items":{"$ref":"#/definitions/KycDocumentJSON"}}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"TaxResidenceV310":{"required":["domain","tax_number","tax_residence_id"],"properties":{"domain":{"type":"string","example":"Enter some domain"},"tax_number":{"type":"string","example":"Enter some number"},"tax_residence_id":{"type":"string","example":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"}}},"SocialMediasJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/SocialMediaJSON"}}}},"CustomerAddressJsonV310":{"required":["city","line_2","customer_id","state","insert_date","tags","customer_address_id","postcode","county","country_code","status","line_3","line_1"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"state":{"type":"string","example":"Brandenburg"},"insert_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"tags":{"type":"array","items":{"type":"string"}},"customer_address_id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"status":{"type":"string","example":"OK"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"CustomerJsonV210":{"required":["customer_id","email","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:53Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"CustomerAttributeResponseJsonV300":{"required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"KycMediaJSON":{"required":["customer_id","url","customer_number","bank_id","id","date","relates_to_kyc_document_id","relates_to_kyc_check_id","type"],"properties":{"customer_id":{"type":"string","example":"PlaceholderString"},"url":{"type":"string","example":"PlaceholderString"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"relates_to_kyc_document_id":{"type":"string","example":"PlaceholderString"},"relates_to_kyc_check_id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"}}},"CustomersMinimalJsonV400":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerMinimalJsonV400"}}}},"CustomerOverviewFlatJsonV500":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","customer_attributes","bank_id","date_of_birth","legal_name","title","accounts"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"legal_name":{"type":"string","example":"Eveline Tripman"},"title":{"type":"string","example":"Dr."},"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountResponseJson500"}}}},"KycMediasJSON":{"required":["medias"],"properties":{"medias":{"type":"array","items":{"$ref":"#/definitions/KycMediaJSON"}}}},"CustomerAttributesResponseJson":{"required":["customer_attributes"],"properties":{"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}}}},"CrmEventsJson":{"required":["crm_events"],"properties":{"crm_events":{"type":"array","items":{"$ref":"#/definitions/CrmEventJson"}}}},"KycChecksJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/KycCheckJSON"}}}},"UserJsonV200":{"required":["provider","email","username","provider_id","user_id","entitlements"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"}}},"CustomerJSONsV300":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV300"}}}},"KycStatusJSON":{"required":["customer_id","customer_number","ok","date"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"ok":{"type":"boolean","example":"true"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"MeetingsJsonV310":{"required":["meetings"],"properties":{"meetings":{"type":"array","items":{"$ref":"#/definitions/MeetingJsonV310"}}}},"MeetingJsonV310":{"required":["present","provider_id","creator","invitees","bank_id","purpose_id","when","meeting_id","keys"],"properties":{"present":{"$ref":"#/definitions/MeetingPresentJson"},"provider_id":{"type":"string","example":"Chris"},"creator":{"$ref":"#/definitions/ContactDetailsJson"},"invitees":{"type":"array","items":{"$ref":"#/definitions/InviteeJson"}},"bank_id":{"type":"string","example":"gh.29.uk"},"purpose_id":{"type":"string","example":"String, eg: onboarding"},"when":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"meeting_id":{"type":"string","example":"UUID-String"},"keys":{"$ref":"#/definitions/MeetingKeysJson"}}},"CustomerAccountLinkJson":{"required":["customer_id","customer_account_link_id","bank_id","account_id","relationship_type"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_account_link_id":{"type":"string","example":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"relationship_type":{"type":"string","example":"Owner"}}},"KycStatusesJSON":{"required":["statuses"],"properties":{"statuses":{"type":"array","items":{"$ref":"#/definitions/KycStatusJSON"}}}},"AttributeDefinitionResponseJsonV400":{"required":["name","is_active","description","attribute_definition_id","alias","bank_id","can_be_seen_on_views","category","type"],"properties":{"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"attribute_definition_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"alias":{"type":"string","example":"STRING"},"bank_id":{"type":"string","example":"gh.29.uk"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"Customer"},"type":{"type":"string","example":"STRING"}}},"TaxResidenceJsonV310":{"required":["tax_residence"],"properties":{"tax_residence":{"type":"array","items":{"$ref":"#/definitions/TaxResidenceV310"}}}},"AttributeDefinitionsResponseJsonV400":{"required":["attributes"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}}}},"KycDocumentJSON":{"required":["number","customer_id","customer_number","issue_date","bank_id","id","type","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"PlaceholderString"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"issue_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"},"issue_place":{"type":"string","example":"PlaceholderString"},"expiry_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"CorrelatedEntities":{"required":["correlated_entities"],"properties":{"correlated_entities":{"type":"array","items":{"$ref":"#/definitions/CustomerAndUsersWithAttributesResponseJson"}}}},"CreateAccountResponseJsonV310":{"required":["account_attributes","branch_id","account_routings","label","balance","user_id","product_code","account_id"],"properties":{"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"branch_id":{"type":"string","example":"DERBY6"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"product_code":{"type":"string","example":"1234BW"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"CustomerAndUsersWithAttributesResponseJson":{"required":["customer","users"],"properties":{"customer":{"$ref":"#/definitions/CustomerJsonV310"},"users":{"type":"array","items":{"$ref":"#/definitions/UserWithAttributesResponseJson"}}}},"UserCustomerLinkJson":{"required":["is_active","customer_id","user_id","date_inserted","user_customer_link_id"],"properties":{"is_active":{"type":"boolean","example":"true"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"date_inserted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user_customer_link_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"CustomerOverviewJsonV500":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","customer_attributes","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status","accounts"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:54Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"},"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountResponseJson500"}}}},"AmountOfMoney":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"1000"}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"url":{"type":"string","example":"www.openbankproject"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"rating":{"type":"string","example":"OBP"},"source":{"type":"string","example":"OBP"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"ContactDetailsJson":{"required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"string","example":"Simon "},"mobile_phone":{"type":"string","example":"+44 07972 444 876"},"email_address":{"type":"string","example":"felixsmith@example.com"}}},"InviteeJson":{"required":["contact_details","status"],"properties":{"contact_details":{"$ref":"#/definitions/ContactDetailsJson"},"status":{"type":"string","example":"String, eg: Good"}}},"CustomerWithAttributesJsonV300":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","customer_attributes","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","example":"19900101"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:53Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"CustomerMessageJson":{"required":["from_person","id","date","from_department","message"],"properties":{"from_person":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"from_department":{"type":"string","example":"String"},"message":{"type":"string","example":"String"}}},"CustomerMessageJsonV400":{"required":["from_person","transport","id","date","from_department","message"],"properties":{"from_person":{"type":"string","example":"Tom"},"transport":{"type":"string","example":"SMS"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"from_department":{"type":"string","example":"Open Bank"},"message":{"type":"string","example":"123456"}}},"CustomerMinimalJsonV400":{"required":["bank_id","customer_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"ContractJsonV500":{"required":["product_code","contract_code"],"properties":{"form_of_payment":{"type":"string"},"maturity_date":{"type":"string"},"renewal_date":{"type":"string"},"interest_rate":{"type":"string"},"instrument_status_code":{"type":"string"},"product_description":{"type":"string"},"issuance_amount":{"type":"string"},"term":{"type":"string"},"is_substituted":{"type":"string"},"opening_date":{"type":"string"},"payment_method":{"type":"string","example":"cache"},"product_code":{"type":"string","example":"787LOW"},"branch_code":{"type":"string"},"contract_code":{"type":"string","example":"LKJL98769F"},"instrument_status_definition":{"type":"string"},"cancellation_date":{"type":"string"},"interest_amount":{"type":"string"}}},"AccountAttributeResponseJson500":{"required":["name","account_attribute_id","product_code","type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"account_attribute_id":{"type":"string","example":"613c83ea-80f9-4560-8404-b9cd4ec42a7f"},"product_code":{"type":"string","example":"1234BW"},"contract_code":{"type":"string","example":"LKJL98769F"},"type":{"type":"string","example":"DATE_WITH_DAY"},"value":{"type":"string","example":"2012-04-23"}}},"AccountResponseJson500":{"required":["account_attributes","branch_id","account_routings","label","balance","product_code","account_id"],"properties":{"contracts":{"type":"array","items":{"$ref":"#/definitions/ContractJsonV500"}},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson500"}},"branch_id":{"type":"string","example":"DERBY6"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"product_code":{"type":"string","example":"787LOW"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"CrmEventJson":{"required":["channel","customer_name","result","customer_number","bank_id","id","scheduled_date","category","detail","actual_date"],"properties":{"channel":{"type":"string","example":"String"},"customer_name":{"type":"string","example":"String"},"result":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"scheduled_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"category":{"type":"string","example":"String"},"detail":{"type":"string","example":"String"},"actual_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"EntitlementJSON":{"required":["entitlement_id","role_name","bank_id"],"properties":{"entitlement_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"EntitlementJSONs":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/EntitlementJSON"}}}},"CustomerJsonV300":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","example":"19900101"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-07-09T12:35:54Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"MeetingPresentJson":{"required":["staff_user_id","customer_user_id"],"properties":{"staff_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"MeetingKeysJson":{"required":["session_id","staff_token","customer_token"],"properties":{"session_id":{"type":"string","example":"String"},"staff_token":{"type":"string","example":"String"},"customer_token":{"type":"string","example":"String"}}},"UserAttributeResponseJsonV400":{"required":["name","insert_date","user_attribute_id","type","value"],"properties":{"name":{"type":"string","example":"BATTERY_LEVEL"},"insert_date":{"type":"string","format":"date","example":"2026-07-09T12:35:54Z"},"user_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"90"}}},"UserWithAttributesResponseJson":{"required":["provider","email","username","provider_id","user_id","user_attributes"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"user_attributes":{"type":"array","items":{"$ref":"#/definitions/UserAttributeResponseJsonV400"}}}},"AccountAttributeResponseJson":{"required":["name","account_attribute_id","product_code","type","value"],"properties":{"name":{"type":"string","example":"OVERDRAFT_START_DATE"},"account_attribute_id":{"type":"string","example":"613c83ea-80f9-4560-8404-b9cd4ec42a7f"},"product_code":{"type":"string","example":"1234BW"},"type":{"type":"string","example":"DATE_WITH_DAY"},"product_instance_code":{"type":"string","example":"LKJL98769F"},"value":{"type":"string","example":"2012-04-23"}}}}}![http://www.example.com/id-docs/123/image.png](\"http://www.example.com/id-docs/123/image.png\"){kind=link}