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"}}}}},"/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}/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/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-05-09T14:09:15.662Z
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-05-09T14:09:15.662Z
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-05-09T14:09:15.662Z
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}/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-05-09T14:09:15.662Z
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/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"}}}}}},"definitions":{"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."}}},"PostCustomerPhoneNumberJsonV400":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"}}},"PostCustomerOverviewJsonV500":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"5987953"}}},"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"}}},"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"}}},"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"}}},"PostCustomerNumberJsonV310":{"required":["customer_number"],"properties":{"customer_number":{"type":"string","example":"5987953"}}},"PostCustomerLegalNameJsonV510":{"required":["legal_name"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"}}},"PostTaxResidenceJsonV310":{"required":["domain","tax_number"],"properties":{"domain":{"type":"string","example":"Enter some domain"},"tax_number":{"type":"string","example":"Enter some number"}}},"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"}}},"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"}}},"PostUserInvitationAnonymousJsonV400":{"required":["secret_key"],"properties":{"secret_key":{"type":"integer","format":"int64","example":"5819479115482092878"}}},"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-05-09T14:09:16Z"},"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"}}},"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-05-09T14:09:18Z"},"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"}}}},"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"}}},"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"}}},"KycMediasJSON":{"required":["medias"],"properties":{"medias":{"type":"array","items":{"$ref":"#/definitions/KycMediaJSON"}}}},"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"}}},"CustomerAddressesJsonV310":{"required":["addresses"],"properties":{"addresses":{"type":"array","items":{"$ref":"#/definitions/CustomerAddressJsonV310"}}}},"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-05-09T14:09:16Z"},"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"}}},"KycChecksJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/KycCheckJSON"}}}},"KycStatusesJSON":{"required":["statuses"],"properties":{"statuses":{"type":"array","items":{"$ref":"#/definitions/KycStatusJSON"}}}},"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"}}},"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"}}},"KycDocumentsJSON":{"required":["documents"],"properties":{"documents":{"type":"array","items":{"$ref":"#/definitions/KycDocumentJSON"}}}},"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"}}}},"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":""}}},"TaxResidenceJsonV310":{"required":["tax_residence"],"properties":{"tax_residence":{"type":"array","items":{"$ref":"#/definitions/TaxResidenceV310"}}}},"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"}}},"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"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"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"}}},"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"}}},"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"}}}}}![http://www.example.com/id-docs/123/image.png](\"http://www.example.com/id-docs/123/image.png\"){kind=link}