Register
API Explorer 1 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Get My Customers at Bank

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

OBPv7.0.0-getMyCustomersAtBank No role required CustomerUser

Returns the Customers at the Bank linked to the User this call is made for.

Called by that User, this is their own linked Customers.

Called by a consent user (an agent identity minted by a Consent), it is the linked Customers of the User the Consent acts for -- all of them at this Bank, exactly as that User sees them -- and only when the Consent's my_resources.linked_customers names this bank_id with the read action. Otherwise the answer is 403 naming the entry that is missing. A Consent never grants a partial view: an agent either sees this Bank's linked Customers or it sees none.

${userAuthenticationMessage(true)}

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 (24)
amount
10.12
bank_id
gh.29.uk
currency
EUR
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
false
last_ok_date
2025-10-21T01:45:31.340Z
legal_name
Eveline Tripman
mobile_phone_number
+49 30 901820
rating
relationship_status
single
source
url
http://www.example.com/id-docs/123/image.png
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": "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-10-21T01:45:41Z"
    }
  ]
}
Possible errors (5)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-35043: The Consent does not cover this personal resource. A consent user may use a personal (my) endpoint only if the Consent lists the resource in my_resources with the needed action.
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMyCustomersAtBank