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

Get User by USER_ID

GET /obp/v7.0.0/users/user-id/USER_ID

OBPv7.0.0-getUserByUserId Roles: CanGetAnyUser User

Get user by USER_ID.

Authentication is required.

CanGetAnyUser entitlement is required.

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

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields (30)
account_id
8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id
gh.29.uk
email
felixsmith@example.com
entitlement_id
entitlements
first_name
Tom
is_deleted
is_deleted
is_locked
is_locked
last_name
Smith
list
provider
ETHEREUM
provider_id
recent_operation_ids
recent_operation_ids
role_name
text
type
user_id
9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username
felixsmith
view_id
owner
agreements
agreements
created_date
created_date
email_validated
email_validated
last_activity_date
last_activity_date
last_marketing_agreement_signed_date
last_marketing_agreement_signed_date
last_used_locale
last_used_locale
mobile_phone_number
+49 30 901820
mobile_phone_number_is_validated
mobile_phone_number_is_validated
mobile_phone_number_validated_date
mobile_phone_number_validated_date
updated_date
updated_date
views
Example success response 
{
  "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email": "felixsmith@example.com",
  "provider_id": "Chris",
  "provider": "http://127.0.0.1:8080",
  "username": "felixsmith",
  "first_name": "Tom",
  "last_name": "Smith",
  "mobile_phone_number": "+44 07972 444 876",
  "mobile_phone_number_is_validated": true,
  "mobile_phone_number_validated_date": "1100-01-01T01:01:01Z",
  "entitlements": {
    "list": [
      {
        "entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
        "role_name": "CanQueryOtherUser",
        "bank_id": "gh.29.uk"
      }
    ]
  },
  "views": {
    "list": [
      {
        "bank_id": "gh.29.uk",
        "account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "view_id": "owner"
      }
    ]
  },
  "agreements": [
    {
      "type": "",
      "text": ""
    }
  ],
  "is_deleted": false,
  "last_marketing_agreement_signed_date": "1100-01-01T00:00:00Z",
  "is_locked": false,
  "created_date": "1100-01-01T00:00:00Z",
  "updated_date": "1100-01-01T00:00:00Z",
  "email_validated": true,
  "last_used_locale": "en_GB",
  "last_activity_date": "1100-01-01T00:00:00Z",
  "recent_operation_ids": [
    "obp.getBank",
    "obp.getAccounts",
    "obp.getTransactions",
    "obp.getUser",
    "obp.getCustomer"
  ]
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getUserByUserId