Entitlement APIs provide Business Banking applications with secure access to business- and user-level entitlements, transaction limits, account permissions, and ACH SEC codes across supported banking features.
End-user benefits
- Business entitlements management.
- User entitlements management.
Integration capabilities
- Retrieve comprehensive entitlements and limits for a business (
businessId, optional institutionCustomerId, optional featureName).
- Retrieve granular entitlements for an individual business banking user (user entitlements endpoint; requires parameters such as
institutionId).
Scopes
| Scope | Description |
|---|
business-profile:read | Read business details |
institution-users:read | Read user details |
| Header | Description |
|---|
Authorization | Bearer token (V2 authentication) |
transactionId | Unique identifier for request tracking |
Error codes (BBE_*)
| Code | Message | HTTP Status Code |
|---|
| BBE-41107 | Error in retrieving institution user | 500 |
| BBE-41108 | Invalid JWT | 401 |
| BBE-41109 | Invalid roles or entitlements | 403 |
| BBE-41110 | Required request parameter not present (e.g. businessId, or institutionId on user entitlements) | 400 |
| BBE-41111 | Unexpected server error | 500 |
Endpoints