Profile APIs provide read access to business profile data for an institution, including company details, primary contact and address information, and optional tax identifiers (TINs) and associated users. These APIs are commonly used to enrich administrative, servicing, and support experiences.
End-user benefits
- Access trusted business identity and contact information from a single source
- Improve admin, servicing, and support workflows with consistent profile data
- Optionally include tax and user details to support broader business context needs
Integration capabilities
- Retrieve business details using a supported identifier, such as a business ID or login ID, depending on the search context.
- Control response payloads by optionally including tax identifiers (TINs) and associated users to meet different use-case needs.
- Responses include core business identity, registration context, and status fields required for downstream processing and decisioning.
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 (BBS_*)
| Code | Message | HTTP Status Code |
|---|
| BBS-40095 | Invalid tinNumber | 400 |
| BBS-40095 | Invalid searchType | 400 |
| BBS-40095 | Invalid institutionId (and other invalid input messages) | 400 |
| BBS-40147 | Business details not found | 400 |
| BBS-40150 | Invalid JWT | 401 |
| BBS-40151 | Invalid roles or entitlements | 403 |
| BBS-40153 | Unexpected server error | 500 |
Endpoints