Business account onboarding
Use this flow to onboard a business account directly or as part of a partner service such as company formation or licensing. Partners can reuse customer information they already hold where the API accepts it, while keeping Hubpay consent and document requirements visible in their journey.
Accounts represent customer entities, linking users, transactions and the underlying multi-currency bank accounts. API credentials and users can link to multiple accounts. Successfully onboarding an account requires the sequence below.
Onboarding flow
Steps
Step 1: Create the account
Create the customer account by providing key details. On success, the response includes an id for the account
which is required in all subsequent steps.
See Create account for details.
Step 2: Update business profile
Complete the business profile with details about the business: legal type, industry, address, financial information, and more. The profile is validated for eligibility automatically.
If the business is not eligible (e.g. not incorporated in the UAE), the application is rejected at this stage. Ensure the business details are correct before submitting: rejected applications cannot be updated via the API.
See Update business profile for details.
Step 3: Upload business documents
Provide the required supporting documents (e.g. trade license, memorandum of association). Use the Get Document Requirements API to see which documents are needed for the account.
Documents go through automated validation and may require acknowledgement if warnings are found. See Business document requirements and Document statuses for details.
Step 4: Add related parties
Add details and documents for individuals and corporate entities related to the business.
- Persons: shareholders, directors, and authorised signatories. See Related persons for details.
- Corporates: parent companies or subsidiaries. See Related corporates for details.
Step 5: Confirm submission
Submit the account for review. This signals that all necessary details and documentation have been captured.
See Confirm submission for details.
Step 6: Add users
Once the application is approved, add users to the account. Each user is assigned a role that determines their level of access.
See Users for details.
What happens after submission
After you confirm the submission (Step 5), the application enters review:
| Outcome | What happens |
|---|---|
| Approved | The account is approved. You can now add users (Step 6). Once fully set up, the account becomes active and can transact. |
| RFI raised | Review needs additional information. Surface the request to the customer and submit their responses. See Responding to RFI. Once every item is resolved, the application resumes review. |
| Rejected | The application was not accepted. Contact support for further details. A new account must be created to retry. |
Webhooks
Subscribe to onboarding webhooks to receive status changes as the account and its documents move through the lifecycle. This avoids polling the API.
- Account events:
created,signed_up,submitted,approved,rejected,onboarded - Document events:
approved,declined,validation_warnings - RFI case events:
opened,closed,cancelled - RFI document events:
approved,declined,validation_warnings
See the Webhooks overview to get started with webhook registration.
Testing in sandbox
Account and document approval decisions are made by Hubpay Ops in production. In sandbox you can drive those decisions yourself to exercise the matching webhook events without waiting on a reviewer.
See Simulating onboarding decisions for the available endpoints, the rules that differ from production, and a complete testing loop.
Partner portal administration
Partner Admins can add onboarding users, assign roles and control which client applications they can access. See Manage onboarding users for the portal workflow.
