API Explorer

v2.0.0 (116 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get all customers for logged in user

Information about the currently authenticated user.

Authentication via OAuth is required.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "customers":[{ "customer_id":"String", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"felixsmith@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getCustomers, operation_id: OBPv2.0.0-getCustomers Tags: Person, Customer,