Skip to main content

Retrieve User Status

Loading...
API endpoint path: /v1/user-status/{institutionUserId}

Returns account activity and registration status for a financial institution user. The response includes status indicators (active, locked, on hold, registered, and related flags), as well as login and hold metadata in additionalInfo. When the requested user is a primary user, status details for associated sub-users are also included.

Use this endpoint to:

  • Look up a user by institution user ID, host user ID (member number), login ID, or customer ID (CUSTOMER_ID).
  • Determine whether a user can sign in or requires intervention (for example, locked, on hold, or pending registration).
  • Retrieve status details for entitled sub-users when querying a primary user.

Behavior and capabilities:

  • userIdType is required. Set it to match the identifier provided in institutionUserId. Supported values include INSTITUTION_USER_ID, HOST_USER_ID, LOGIN_ID, and CUSTOMER_ID. HOST_USER_ID is not applicable to business banking users.
  • Requires the institution-users:read scope. This endpoint returns status fields only. Use Retrieve Institution User (V1) or Retrieve Institution User (V2) for full profile data (contact methods, postal addresses, and related attributes).

Request​

Responses​

Success