The Onboarding API handles everything required to bring a new business onto the Union Bank BaaS platform. You call these endpoints once during setup; after your business is approved and live, you do not need them again in day-to-day operations.The onboarding sequence is:
Copy
Ask AI
Register → Verify Email → Submit KYB Documents → KYC Check → Request API Keys → Go Live Review
All onboarding endpoints are available in the sandbox environment so you can complete the full flow before touching production.
The Register and Verify Email endpoints are public — they require no API key.All subsequent onboarding endpoints (KYB submission, status checks) require a Bearer token obtained from the registration step, until your API key is issued.
The interactive playground below is powered by the OpenAPI specification. Click Try it on any endpoint, fill in the fields, and send a live request to the sandbox.
POST /v1/onboarding/registerCreates a new business account on the platform. You provide your business name, email, and contact details. The platform sends a verification email immediately after this call succeeds.What you send:
Field
Type
Required
Description
business_name
string
Yes
Legal registered name of your business
email
string
Yes
Primary contact email (must be a real inbox — a verification code is sent here)
phone
string
Yes
Business phone number in international format (e.g., +2348012345678)
country
string
Yes
Two-letter country code — NG for Nigeria
business_type
string
Yes
One of: sole_proprietor, partnership, limited_liability, public_company
What you get back:
Field
Description
business_id
Unique ID for your business — save this
registration_token
Short-lived token used in subsequent onboarding calls
POST /v1/onboarding/verify-emailConfirms that the email address provided during registration belongs to you. Enter the 6-digit code that was emailed to you.What you send:
POST /v1/onboarding/kybUpload your business verification documents. KYB stands for Know Your Business — the process banks use to confirm that your company is real and legitimate.Accepted document types:
Document
Description
cac_certificate
CAC Certificate of Incorporation from the Corporate Affairs Commission
cac_7
CAC Form 7 — list of directors
cac_2
CAC Form 2 — statement of share capital
tax_identification
Tax Identification Number (TIN) certificate
utility_bill
Recent utility bill for business address (not older than 3 months)
directors_id
Government-issued ID for each director
Documents must be uploaded as base64-encoded strings in the request body. Accepted formats: PDF, JPG, PNG. Maximum 5 MB per file.
All documents are encrypted with AES-256-CBC before storage. Never send raw document data over an unencrypted connection.
POST /v1/onboarding/api-keysOnce your KYB is approved, generate your first API key. This key is what you will use to authenticate all future API calls.What you send:
Field
Type
Required
Description
name
string
Yes
A label for this key (e.g., production-app, mobile-backend)
environment
string
Yes
sandbox or production
permissions
array
Yes
List of permission scopes (e.g., accounts:read, payments:write)
What you get back:The full API key is shown once only in this response. Copy and store it securely immediately — it cannot be retrieved again.
The full interactive playground for all Onboarding endpoints is available in the API Reference tab. Select Onboarding from the tag filter to see only onboarding endpoints.
