GET /obp/v7.0.0/banks/BANK_ID/customers

OBPv7.0.0-getCustomersAtOneBank Roles: CanGetCustomersAtOneBank(per bank) Customer User

Get the Customers at the bank, each with its Customer Attributes, optionally filtered by Customer Attributes.

Filtering by Customer Attributes: a query parameter is the name of a Customer Attribute and its value the attribute value a Customer must have. Several accepted values are separated by commas, so a value cannot itself contain a comma; different names must all match. A name can be given only once (as on every endpoint, a repeated query parameter name is refused), and a filter without a value is refused.

Not taken for attribute names, in any letter case: limit, offset, sort_direction, from_date, to_date, sort_by, and names starting with obp_ or _. Apart from limit, offset and sort_direction (lower case) they are accepted and ignored, as in v6.0.0.

A single value of a parameter whose name ends in currency or currency_code that looks like a currency code is upper-cased by OBP-API before it is matched, as on every endpoint; comma-separated values are matched as given.

Examples:

?organisation_kind=university returns the Customers whose attribute organisation_kind is university.
?organisation_kind=university,regulator returns those whose organisation_kind is either.
?organisation_kind=university&city=Muscat returns those with both attributes.

Paging:

limit: maximum number of Customers to return (default 50)
offset: number of Customers to skip (default 0)
sort_direction: ASC or DESC (default DESC)

Without attribute filters the Customers at the bank are ordered by last_ok_date, as in v6.0.0. With attribute filters the matching Customers are ordered by customer_id, and limit and offset count the matching Customers only. A Customer that no longer exists but still has an attribute is left out, so such a page can hold fewer Customers than limit. The ids of all matching Customers are read before the page is chosen.

Dates are returned as YYYY-MM-DD.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

{ "customers": [ { "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": "1990-05-15", "relationship_status": "single", "dependants": 1, "dob_of_dependants": [ "2015-03-20", "2018-07-10" ], "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-11-10T14:05:32Z", "title": "Dr.", "branch_id": "DERBY6", "name_suffix": "Sr", "customer_type": "INDIVIDUAL", "parent_customer_id": "", "customer_attributes": [ { "customer_attribute_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name": "SPECIAL_TAX_NUMBER", "type": "STRING", "value": "123456789" } ] } ] }