API Explorer 1884 endpoints

Get Customers at Bank

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

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

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.

Every other query parameter is an attribute filter, so a misspelt name is not refused: it filters by an attribute of that name. For example, ?limt=10 asks for the Customers with an attribute limt whose value is 10. That usually matches no Customer, and the answer is an empty list, not an error. Check the spelling of limit, offset and sort_direction when a call returns no Customers.

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

JSON response body fields (34)
amount
10.12
bank_id
gh.29.uk
branch_id
DERBY6
currency
EUR
customer_attribute_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_attributes
customer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number
5987953
customer_type
INDIVIDUAL
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
false
last_ok_date
2025-11-18T15:14:33.829Z
legal_name
Eveline Tripman
mobile_phone_number
+49 30 901820
name
ACCOUNT_MANAGEMENT_FEE
name_suffix
Sr
parent_customer_id
rating
relationship_status
single
source
title
Dr.
type
url
http://www.example.com/id-docs/123/image.png
value
5987953
credit_limit
credit_rating
Example success response
{
  "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-18T15:16:08Z",
      "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"
        }
      ]
    }
  ]
}
Possible errors (7)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-10034: Invalid URL parameters.
  • OBP-10016: Incorrect filter Parameters in URL.
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getCustomersAtOneBank