Registration
Registration APIs support business customer onboarding by allowing institutions to load registration configuration, submit new registrations, and retrieve submissions using a 16‑character confirmation number or a system‑generated registration ID.
End-user benefits
- Streamlined business onboarding with a returned confirmation number.
- Registration forms driven by institution-specific online features and additional services lists.
- Track submissions using confirmation number or registration ID.
Integration capabilities
- Retrieve institution-specific settings to dynamically build registration experiences.
- Submit complete business registration data and receive a 16‑character alphanumeric confirmation number for external tracking.
- Retrieve registrations using either the confirmation number or the registration ID to support back‑office workflows.
- Use well-defined identifier formats for client-side validation and efficient lookups.
Scopes
| Scope | Description |
|---|---|
business-registrations:read | Read registration configuration and registrations |
business-registrations:write | Create business registrations |
institution-users:read | Read user details |
Required headers
| 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 confirmationNumber | 400 |
| BBS-40095 | Invalid institutionId | 400 |
| BBS-40150 | Invalid JWT | 401 |
| BBS-40151 | Invalid roles or entitlements | 403 |
| BBS-40153 | Unexpected server error | 500 |
| BBS-40154 | Business registration not found | 404 |
Endpoints
Get Business Registration Configuration
Retrieves the business registration configuration for a specific financial institution. This endpoint provides all settings required to render the business registration form, including:
Get Business Registration by Confirmation Number
Retrieves a business banking registration using the unique confirmation number. The confirmation number is a 16-character alphanumeric code that was generated when the registration was created.
Get Business Registration by Registration ID
Retrieves a business banking registration using the unique registration ID. The registration ID is an alphanumeric code that was generated when the registration was created.
Create Business Registration
Creates a new business banking registration for a financial institution. This endpoint accepts comprehensive business registration details including: