# Union Bank BaaS

## Docs

- [Accounts API](https://docs.onecluster.co/api-reference/accounts.md): Create and manage virtual bank accounts for your customers. Each account has a unique NUBAN number and can send and receive real money.
- [Authentication](https://docs.onecluster.co/api-reference/authentication.md): How to authenticate with the UBN BaaS API
- [Collections API](https://docs.onecluster.co/api-reference/collections.md): Accept incoming payments from customers. Generate payment links, track incoming transfers, and reconcile collections against your records.
- [Account Enquiry](https://docs.onecluster.co/api-reference/endpoints/account-enquiry.md): **Always call this before initiating a transfer.** It confirms the destination account exists and returns the account holder's name so your user can verify they are sending to the right person.
- [CAC Lookup](https://docs.onecluster.co/api-reference/endpoints/cac-lookup.md): Looks up a Nigerian company's registration details in the CAC (Corporate Affairs Commission) registry using their RC number.
- [Create Virtual Account](https://docs.onecluster.co/api-reference/endpoints/create-account.md): Opens a new virtual bank account. Virtual accounts are real Nigerian bank accounts (with valid account numbers) that sit under your master account.
- [Create Collection Account](https://docs.onecluster.co/api-reference/endpoints/create-collection-account.md): Creates a virtual account specifically for receiving money (collections).
- [Delete Webhook](https://docs.onecluster.co/api-reference/endpoints/delete-webhook.md): Permanently removes a webhook endpoint. You will stop receiving notifications to this URL immediately.
- [Generate API Key](https://docs.onecluster.co/api-reference/endpoints/generate-api-key.md): Creates a new API key for your account.
- [Get Account Balance](https://docs.onecluster.co/api-reference/endpoints/get-balance.md): Returns the current balance and details for a virtual account.
- [Get Collection Transactions](https://docs.onecluster.co/api-reference/endpoints/get-collection-transactions.md): Returns all inbound payments received by a collection account.
- [Health Check](https://docs.onecluster.co/api-reference/endpoints/get-health.md): Check if the API gateway is online. No authentication required.
- [Get Payment Status](https://docs.onecluster.co/api-reference/endpoints/get-payment-status.md): Poll this endpoint after initiating a transfer to get the final outcome.
- [Get Pricing](https://docs.onecluster.co/api-reference/endpoints/get-pricing.md): Returns the current per-call pricing for each API product.
- [Get Production Access Status](https://docs.onecluster.co/api-reference/endpoints/get-production-access-status.md): Check where your production access request is in the review process.
- [Get Account Statement](https://docs.onecluster.co/api-reference/endpoints/get-statement.md): Returns a paginated list of transactions for a virtual account within a date range.
- [System Status](https://docs.onecluster.co/api-reference/endpoints/get-status.md): Detailed system status for all API products. No authentication required.
- [Get Wallet](https://docs.onecluster.co/api-reference/endpoints/get-wallet.md): Returns your wallet balance, available balance, liened amount, and VA funding details.
- [Get Wallet Statement](https://docs.onecluster.co/api-reference/endpoints/get-wallet-statement.md): Returns your paginated wallet statement — credits, holds, debits, and releases.
- [Get Webhook Deliveries](https://docs.onecluster.co/api-reference/endpoints/get-webhook-deliveries.md): Shows a log of all webhook notifications we have attempted to send, including whether they succeeded and any error responses from your endpoint.
- [Initiate Transfer](https://docs.onecluster.co/api-reference/endpoints/initiate-transfer.md): Initiates a funds transfer from one of your virtual accounts to any Nigerian bank account.
- [List API Keys](https://docs.onecluster.co/api-reference/endpoints/list-api-keys.md): Returns all API keys for your account. For security, only the key **prefix** (first 8 characters) is shown — never the full key. If you have lost a key, you must rotate it to get a new one.
- [List Webhooks](https://docs.onecluster.co/api-reference/endpoints/list-webhooks.md): Returns all webhook endpoints registered for your account.
- [Register Business](https://docs.onecluster.co/api-reference/endpoints/register.md): **Step 1 of onboarding.** Create a new partner account for your company.
- [Register Webhook](https://docs.onecluster.co/api-reference/endpoints/register-webhook.md): Register a URL that we will call when money arrives in any of your collection accounts.
- [Request Production Access](https://docs.onecluster.co/api-reference/endpoints/request-production-access.md): After testing in sandbox, submit this request to move to the live production environment.
- [Revoke API Key](https://docs.onecluster.co/api-reference/endpoints/revoke-api-key.md): Permanently revokes an API key with **no grace period**. Any request using this key after revocation will receive a `401 Unauthorized` response.
- [Rotate API Key](https://docs.onecluster.co/api-reference/endpoints/rotate-api-key.md): Generates a new API key and gives you **72 hours** to update your systems. During this 72-hour grace period, your **old key continues to work** — you will see an `X-Key-Rotation-Warning` header on responses to remind you.
- [Verify BVN](https://docs.onecluster.co/api-reference/endpoints/verify-bvn.md): Verifies a BVN against the NIBSS (Nigerian Interbank Settlement System) database and checks if the name matches the record on file.
- [Verify Email](https://docs.onecluster.co/api-reference/endpoints/verify-email.md): **Step 2 of onboarding.** Submit the one-time code sent to your email after registration.
- [Verify NIN](https://docs.onecluster.co/api-reference/endpoints/verify-nin.md): Verifies a NIN against the NIMC (National Identity Management Commission) database. Returns masked identity information — full PII is never exposed.
- [Error Reference](https://docs.onecluster.co/api-reference/errors.md): Every error code, what it means, and how to fix it
- [KYC API](https://docs.onecluster.co/api-reference/kyc.md): Verify your customers' identities using BVN, NIN, and CAC lookups. Required for compliance with CBN regulations on financial services.
- [Onboarding API](https://docs.onecluster.co/api-reference/onboarding.md): Register your business, submit verification documents, and obtain API keys — all via the Onboarding API.
- [API Reference Overview](https://docs.onecluster.co/api-reference/overview.md): Base URLs, request format, response format, and versioning
- [Payments API](https://docs.onecluster.co/api-reference/payments.md): Send money from a virtual account to any Nigerian bank account. Supports instant NIP transfers and scheduled bulk payments.
- [Glossary — Plain English Definitions](https://docs.onecluster.co/glossary.md): Every technical term used in these docs, explained in plain English. If you encounter a word you do not understand anywhere in the documentation, look it up here.
- [Welcome to UBN BaaS](https://docs.onecluster.co/introduction.md): Build financial products on Union Bank's infrastructure — virtual accounts, payments, collections, and identity verification, all through one API.
- [Key Concepts](https://docs.onecluster.co/key-concepts.md): The ideas behind the UBN BaaS platform, explained in plain English with real-world analogies. Read this before diving into the product guides.
- [Step 5: Your API Keys](https://docs.onecluster.co/onboarding/api-keys.md): Understanding, securing, and managing your API keys
- [Step 6: Go Live — Request Production Access](https://docs.onecluster.co/onboarding/go-live.md): Everything you need to move from sandbox testing to real transactions
- [Step 3: Submit Business Documents (KYB)](https://docs.onecluster.co/onboarding/kyb-documents.md): Upload your company's compliance documents for verification
- [Step 4: Identity Verification (KYC)](https://docs.onecluster.co/onboarding/kyc-verification.md): Automated identity checks that run after your documents are approved
- [Onboarding Overview](https://docs.onecluster.co/onboarding/overview.md): Everything you need to do before your first live API call
- [Step 1: Register Your Company](https://docs.onecluster.co/onboarding/register.md): Create your partner account on the UBN BaaS platform
- [Step 2: Verify Your Email](https://docs.onecluster.co/onboarding/verify-email.md): Confirm your email address before uploading documents
- [Billing & Wallet](https://docs.onecluster.co/products/billing.md): How API billing works — prepaid wallet, pay-as-you-go, lien-capture-release
- [Collections — Receive Money](https://docs.onecluster.co/products/collections.md): Set up virtual accounts to collect payments from your customers
- [Identity Verification (KYC)](https://docs.onecluster.co/products/kyc.md): Verify the identity of your customers using BVN, NIN, and CAC lookups
- [Payments & Transfers](https://docs.onecluster.co/products/payments.md): Send money from your virtual accounts to any Nigerian bank
- [Virtual Accounts](https://docs.onecluster.co/products/virtual-accounts.md): Open Nigerian bank accounts programmatically for your customers
- [Webhooks — Real-Time Notifications](https://docs.onecluster.co/products/webhooks.md): Get notified instantly when money arrives or events happen
- [Quickstart: Your First API Call in 5 Minutes](https://docs.onecluster.co/quickstart.md): Go from zero to a successful API response in 5 minutes. No banking knowledge required.
- [API Changelog](https://docs.onecluster.co/resources/changelog.md): All changes to the UBN BaaS API, newest first
- [Postman Collection](https://docs.onecluster.co/resources/postman.md): Test the UBN BaaS API with our ready-made Postman collection
- [Sandbox Guide](https://docs.onecluster.co/resources/sandbox-guide.md): Everything you need to know about testing in the sandbox
- [Support](https://docs.onecluster.co/resources/support.md): How to get help with the UBN BaaS platform
- [NDPR Compliance](https://docs.onecluster.co/security/ndpr-compliance.md): How we handle personal data and what it means for you
- [Security Overview](https://docs.onecluster.co/security/overview.md): How we protect your data and how you protect your integration
- [Rate Limits & Quotas](https://docs.onecluster.co/security/rate-limits.md): How many API calls you can make and what to do when you hit the limit

## OpenAPI Specs

- [openapi-public](https://docs.onecluster.co/api-reference/openapi-public.yaml)
- [openapi](https://docs.onecluster.co/api-reference/openapi.yaml)

## Optional

- [Sandbox Portal](https://dev-ubn-ui.onecluster.co)
- [GitHub](https://github.com/UBN-Project/UBN)