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

Get My Customers

GET /obp/v7.0.0/my/customers

OBPv7.0.0-getMyCustomers No role required CustomerUser

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

Called by that User, this is all of 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, at the Banks the Consent's my_resources.linked_customers names with the read action. A Consent that names no Bank gets 403 rather than an empty list, so an agent is never left unable to tell "you may not see this" from "there is nothing here".

${userAuthenticationMessage(true)}

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

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 (4)
  • OBP-20001: User not logged in. Authentication is required!
  • 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 getMyCustomers