Skip to main content

Retrieve Institution User (V1)

Loading...
API endpoint path: /v1/institution-users/{institutionUserId}

Returns profile and relationship data for a single financial institution user. The response includes identity fields (name, email, username), user status, role, user type, associated institution customers, and login activity indicators. For business banking users, entitled location information may also be included.

Use this endpoint to:

  • Retrieve a user by institution user ID, host user ID (member number), login ID, legacy user GUID, or authentication user ID (authId).
  • Include the institution user's contact methods, postal addresses, or sub-users by specifying them in the $expand query parameter using OData expressions.
  • Return bill pay credentials for the OFX (Open Financial Exchange) bill pay integration service by setting retrieveBillPayCredentials=true. This option is intended only for approved integrations and not for general profile lookups.

Behavior and capabilities:

  • userIdType defaults to INSTITUTION_USER_ID when not specified. Set it to match the identifier provided in institutionUserId. HOST_USER_ID is not applicable to business banking users.
  • $expand accepts OData expressions. Supported segments include contactMethods, postalAddresses, and subUsers. postalAddress is also accepted as an alias for postalAddresses.
  • Setting retrieveBillPayCredentials=true requires the institution-users-billpay:read scope in addition to standard read access. Use this parameter only for the OFX (Open Financial Exchange) bill pay integration service; leave it as false (default) for typical profile lookups.

Request​

Responses​

Success