API Explorer

v2.0.0 (175 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:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: true

last_ok_date: 2023-02-27T14:01:45.181Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

relationship_status: single

url: http://www.example.com/id-docs/123/image.png

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":"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"], "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2023-02-27T14:01:45Z" }] }
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, Old-Style,