Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"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\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_MEDIA_ID](/glossary#kyc_media_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"customer_number":"5987953","type":"image","url":"http://www.example.com/id-docs/123/image.png","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"123","relates_to_kyc_check_id":"123"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"url":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanAddKycMedia","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"getKycMedia"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_media","summary":"Get KYC Media for a customer","description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**medias**](/glossary#medias): \n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n","success_response_body":{"medias":[{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycMedia","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_media","connector_methods":[]},{"operation_id":"OBPv3.1.0-createTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"createTaxResidence"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence","summary":"Create Tax Residence","description":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\n\ntax_number: 456
\nJSON response body fields:
\n\ntax_number: 456
\n\n","description_markdown":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n[**tax_residence_id**](/glossary#tax_residence_id): \n\n\n","example_request_body":{"domain":"Enter some domain","tax_number":"Enter some number"},"success_response_body":{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}},"roles":[{"role":"CanCreateTaxResidence","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerOverviewFlat","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerOverviewFlat"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers/customer-number-query/overview-flat","summary":"Get Customer Overview Flat","description":"Gets the Customer Overview Flat specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncontract_code: contract_code
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate_of_birth: 2018-03-09
\n\nlabel: My Account
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\nscheme: OBP
\ntitle: Dr.
\ntype:
\nvalue: 5987953
\nbranch_code: branch_code
\ncancellation_date: cancellation_date
\ncontract_code: contract_code
\ncontracts: contracts
\nform_of_payment: form_of_payment
\ninstrument_status_code: instrument_status_code
\ninstrument_status_definition: instrument_status_definition
\ninterest_amount: interest_amount
\ninterest_rate: interest_rate
\nis_substituted: is_substituted
\nissuance_amount: issuance_amount
\nmaturity_date: maturity_date
\nopening_date: opening_date
\npayment_method: payment_method
\nproduct_description: product_description
\nrenewal_date: renewal_date
\nterm: term
\n","description_markdown":"Gets the Customer Overview Flat specified by customer_number and bank_code.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n[**contract_code**](/glossary#): contract_code\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#Adapter.value): 5987953\n\n\n\n[branch_code](/glossary#): branch_code\n\n\n\n[cancellation_date](/glossary#): cancellation_date\n\n\n\n[**contract_code**](/glossary#): contract_code\n\n\n\n[contracts](/glossary#): contracts\n\n\n\n[form_of_payment](/glossary#): form_of_payment\n\n\n\n[instrument_status_code](/glossary#): instrument_status_code\n\n\n\n[instrument_status_definition](/glossary#): instrument_status_definition\n\n\n\n[interest_amount](/glossary#): interest_amount\n\n\n\n[interest_rate](/glossary#): interest_rate\n\n\n\n[is_substituted](/glossary#): is_substituted\n\n\n\n[issuance_amount](/glossary#): issuance_amount\n\n\n\n[maturity_date](/glossary#): maturity_date\n\n\n\n[opening_date](/glossary#): opening_date\n\n\n\n[payment_method](/glossary#): payment_method\n\n\n\n[product_description](/glossary#): product_description\n\n\n\n[renewal_date](/glossary#): renewal_date\n\n\n\n[term](/glossary#): term\n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","date_of_birth":"1100-01-01T00:00:00Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}],"accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"My Account","product_code":"787LOW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","contracts":[{"product_code":"787LOW","contract_code":"LKJL98769F","payment_method":"cache"}],"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"contract_code":"LKJL98769F","product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"email":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"contracts":{"type":"array","items":{"type":"object","properties":{"payment_method":{"type":"string"},"product_code":{"type":"string"},"contract_code":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"}}},"roles":[{"role":"CanGetCustomerOverviewFlat","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number-query/overview-flat","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCustomersByLegalName","implemented_by":{"version":"OBPv5.1.0","function":"getCustomersByLegalName"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/customers/legal-name","summary":"Get Customers by Legal Name","description":"Gets the Customers specified by Legal Name.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nlegal_name: Eveline Tripman
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-06-06T17:37:08.281Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Gets the Customers specified by Legal Name.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#Customer.dependants): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-06-06T17:37:08.281Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"legal_name":"Eveline Tripman"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-06-06T17:37:10Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"legal_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomersAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/legal-name","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycStatuses","implemented_by":{"version":"OBPv2.0.0","function":"getKycStatuses"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_statuses","summary":"Get Customer KYC statuses","description":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n\n","description_markdown":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): false\n\n\n\n[**statuses**](/glossary#statuses): \n\n\n","success_response_body":{"statuses":[{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"statuses":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetAnyKycStatuses","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerOverview","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerOverview"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers/customer-number-query/overview","summary":"Get Customer Overview","description":"Gets the Customer Overview specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlabel: My Account
\nlast_ok_date: 2025-06-06T17:37:08.281Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\n\nrelationship_status: single
\nscheme: OBP
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\ncontract_code: contract_code
\ncontracts: contracts
\n\n\n","description_markdown":"Gets the Customer Overview specified by customer_number and bank_code.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#Customer.dependants): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-06-06T17:37:08.281Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#Adapter.value): 5987953\n\n\n\n[contract_code](/glossary#): contract_code\n\n\n\n[contracts](/glossary#): contracts\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-06-06T17:37:11Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}],"accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"My Account","product_code":"787LOW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"contract_code":"LKJL98769F","product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomerOverview","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number-query/overview","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycStatus","implemented_by":{"version":"OBPv2.0.0","function":"addKycStatus"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","summary":"Add KYC Status","description":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n","description_markdown":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): false\n\n\n","example_request_body":{"customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"},"success_response_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-00004: Server error: could not add message","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}},"roles":[{"role":"CanAddKycStatus","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"operation_id":"OBPv4.0.0-createUserInvitation","implemented_by":{"version":"OBPv4.0.0","function":"createUserInvitation"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitation","summary":"Create User Invitation","description":"Create User Invitation.
\nThis endpoint will send an invitation email to the developers, then they can use the link to create the obp user.
\npurpose filed only support:List(DEVELOPER, CUSTOMER).
\nYou can customise the email details use the following webui props:
\nwhen purpose == DEVELOPER
\nwebui_developer_user_invitation_email_subject
\nwebui_developer_user_invitation_email_from
\nwebui_developer_user_invitation_email_text
\nwebui_developer_user_invitation_email_html_text
when purpose = == CUSTOMER
\nwebui_customer_user_invitation_email_subject
\nwebui_customer_user_invitation_email_from
\nwebui_customer_user_invitation_email_text
\nwebui_customer_user_invitation_email_html_text
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Create User Invitation.\n\n This endpoint will send an invitation email to the developers, then they can use the link to create the obp user.\n\n purpose filed only support:List(DEVELOPER, CUSTOMER).\n\n You can customise the email details use the following webui props:\n\n when purpose == DEVELOPER\n webui_developer_user_invitation_email_subject\n webui_developer_user_invitation_email_from\n webui_developer_user_invitation_email_text\n webui_developer_user_invitation_email_html_text\n\n when purpose = == CUSTOMER\n webui_customer_user_invitation_email_subject\n webui_customer_user_invitation_email_from\n webui_customer_user_invitation_email_text\n webui_customer_user_invitation_email_html_text\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER"},"success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User-Invitation","KYC"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"roles":[{"role":"CanCreateUserInvitation","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitation","connector_methods":[]},{"operation_id":"OBPv3.1.0-getTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"getTaxResidence"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residences","summary":"Get Tax Residences of Customer","description":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ntax_number: 456
\n\n\n","description_markdown":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n[**tax_residence**](/glossary#tax_residence): \n\n\n\n[**tax_residence_id**](/glossary#tax_residence_id): \n\n\n","success_response_body":{"tax_residence":[{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"typed_success_response_body":{"type":"object","properties":{"tax_residence":{"type":"array","items":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetTaxResidence","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residences","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycDocument","implemented_by":{"version":"OBPv2.0.0","function":"addKycDocument"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_ID","summary":"Add KYC Document","description":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"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. \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_DOCUMENT_ID](/glossary#kyc_document_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"customer_number":"5987953","type":"passport","number":"12345","issue_date":"1100-01-01T00:00:00Z","issue_place":"Berlin","expiry_date":"1100-01-01T00:00:00Z"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1100-01-01T00:00:00Z","issue_place":"PlaceholderString","expiry_date":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","Server error: could not add KycDocument","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"issue_place":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"issue_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"type":{"type":"string"},"number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanAddKycDocument","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteCustomerAddress","implemented_by":{"version":"OBPv3.1.0","function":"deleteCustomerAddress"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","summary":"Delete Customer Address","description":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ADDRESS_ID](/glossary#customer_address_id): \n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"roles":[{"role":"CanDeleteCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"deleteTaxResidence"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","summary":"Delete Tax Residence","description":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","description_markdown":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[TAX_RESIDENCE_ID](/glossary#tax_residence_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"roles":[{"role":"CanDeleteTaxResidence","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycDocuments","implemented_by":{"version":"OBPv2.0.0","function":"getKycDocuments"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_documents","summary":"Get Customer KYC Documents","description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
\nGet a list of documents that affirm the identity of the customer
\nPassport, driving licence etc.
\nUser Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID\nGet a list of documents that affirm the identity of the customer\nPassport, driving licence etc.\nUser Authentication is Optional. The User need not be logged in.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**documents**](/glossary#documents): \n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"documents":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1100-01-01T00:00:00Z","issue_place":"PlaceholderString","expiry_date":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycDocuments","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_documents","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserInvitationAnonymous","implemented_by":{"version":"OBPv4.0.0","function":"getUserInvitationAnonymous"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitations","summary":"Get User Invitation Information","description":"Get User Invitation Information.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nsecret_key: secret_key
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Get User Invitation Information.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**secret_key**](/glossary#): secret_key\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"secret_key":5819479115482092878},"success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30008: User Customer Link not found by USER_ID","OBP-37882: Cannot get user invitation.","OBP-37883: Cannot find user invitation.","OBP-50000: Unknown Error."],"tags":["User-Invitation","KYC"],"typed_request_body":{"type":"object","properties":{"secret_key":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitations","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCustomerAddresses","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerAddresses"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses","summary":"Get Customer Addresses","description":"Get the Addresses of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","description_markdown":"Get the Addresses of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**addresses**](/glossary#addresses): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**customer_address_id**](/glossary#customer_address_id): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"addresses":[{"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK","insert_date":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"typed_success_response_body":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"country_code":{"type":"string"},"county":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycCheck","implemented_by":{"version":"OBPv2.0.0","function":"addKycCheck"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","summary":"Add KYC Check","description":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","description_markdown":"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\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_CHECK_ID](/glossary#kyc_check_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): false\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","example_request_body":{"customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"online_meeting","staff_user_id":"67876","staff_name":"Simon","satisfied":true,"comments":"String"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"staff_user_id":{"type":"string"},"staff_name":{"type":"string"},"comments":{"type":"string"},"how":{"type":"string"},"satisfied":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}},"roles":[{"role":"CanAddKycCheck","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycChecks","implemented_by":{"version":"OBPv2.0.0","function":"getKycChecks"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_checks","summary":"Get Customer KYC Checks","description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","description_markdown":"Get KYC checks for the Customer specified by CUSTOMER_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**checks**](/glossary#checks): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): false\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","success_response_body":{"checks":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycChecks","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_checks","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomersByCustomerPhoneNumber","implemented_by":{"version":"OBPv4.0.0","function":"getCustomersByCustomerPhoneNumber"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/search/customers/mobile-phone-number","summary":"Get Customers by MOBILE_PHONE_NUMBER","description":"Gets the Customers specified by MOBILE_PHONE_NUMBER.
\nThere are two wildcards often used in conjunction with the LIKE operator:
\n% - The percent sign represents zero, one, or multiple characters
\n_ - The underscore represents a single character
\nFor example {"customer_phone_number":"%381%"} lists all numbers which contain 381 sequence
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nmobile_phone_number: +49 30 901820
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-06-06T17:37:08.281Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Gets the Customers specified by MOBILE_PHONE_NUMBER.\n\nThere are two wildcards often used in conjunction with the LIKE operator:\n % - The percent sign represents zero, one, or multiple characters\n _ - The underscore represents a single character\nFor example {\"customer_phone_number\":\"%381%\"} lists all numbers which contain 381 sequence\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#Customer.dependants): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-06-06T17:37:08.281Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"mobile_phone_number":"+44 07972 444 876"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-06-06T17:37:10Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomersAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/search/customers/mobile-phone-number","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCustomerByCustomerNumber","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerByCustomerNumber"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/customer-number","summary":"Get Customer by CUSTOMER_NUMBER","description":"Gets the Customer specified by CUSTOMER_NUMBER.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-06-06T17:37:08.281Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","description_markdown":"Gets the Customer specified by CUSTOMER_NUMBER.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#Customer.dependants): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-06-06T17:37:08.281Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#Adapter.value): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-06-06T17:37:10Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomersAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number","connector_methods":[]}]}![http://www.example.com/id-docs/123/image.png](\"http://www.example.com/id-docs/123/image.png\"){kind=link}