# Rolla API

## Docs

- [Add Related Person](https://docs.rolla.xyz/api-reference/endpoint/accounts/add-related-person.md): Adds a beneficial owner or director to a business account's application. Each related person must complete identity verification (via a KYC link) before the application can be submitted.
- [Get Issuance Requirements](https://docs.rolla.xyz/api-reference/endpoint/accounts/bank-account-requirements.md): Shows which provider will be used for the given currency, the details prefilled from the account's application, and anything still missing before a bank account can be issued. Use this to know exactly what to pass in `accountData` when issuing.
- [Create Account](https://docs.rolla.xyz/api-reference/endpoint/accounts/create.md): Creates an additional business or individual account under the same owner as your API key's business. The new account starts as a draft KYB/KYC application that you complete via the other account onboarding endpoints.
- [Delete Document](https://docs.rolla.xyz/api-reference/endpoint/accounts/delete-document.md): Deletes an uploaded document by type. Use `relatedPersonId` to target a related person's document.
- [Delete Related Person](https://docs.rolla.xyz/api-reference/endpoint/accounts/delete-related-person.md): Removes a related person and their uploaded documents from a business account's application.
- [Get Funding Instructions](https://docs.rolla.xyz/api-reference/endpoint/accounts/funding-instructions.md): Fetch deposit instructions for an account across its currencies
- [Get Account](https://docs.rolla.xyz/api-reference/endpoint/accounts/get.md): Retrieves an account with its full KYB/KYC application and uploaded documents.
- [List Documents](https://docs.rolla.xyz/api-reference/endpoint/accounts/get-documents.md): Lists documents uploaded for the account's application.
- [Issue Bank Account](https://docs.rolla.xyz/api-reference/endpoint/accounts/issue-bank-account.md): Issues an NGN or USD deposit account for an approved account. The provider is chosen automatically based on currency and account type. NGN accounts are issued immediately. USD accounts require provider review: the first call submits the account's application data to the provider and returns `202`; c…
- [Generate KYC Link](https://docs.rolla.xyz/api-reference/endpoint/accounts/kyc-link.md): Generates a hosted identity verification link for a related person. Share the link with the person so they can upload their ID and complete a liveness check. Generating a new link invalidates the previous one. Links expire after 72 hours.
- [List Accounts](https://docs.rolla.xyz/api-reference/endpoint/accounts/list.md): Lists all accounts owned by the same user as your API key's business, including the originating account, with their application status.
- [List Bank Accounts](https://docs.rolla.xyz/api-reference/endpoint/accounts/list-bank-accounts.md): Lists the account's issued bank accounts, plus any USD provider onboarding still in review.
- [List Related Persons](https://docs.rolla.xyz/api-reference/endpoint/accounts/list-related-persons.md): Lists the beneficial owners and directors registered on a business account's application.
- [Account Onboarding Overview](https://docs.rolla.xyz/api-reference/endpoint/accounts/overview.md): Onboard additional business or individual accounts programmatically
- [Get Requirements](https://docs.rolla.xyz/api-reference/endpoint/accounts/requirements.md): Returns a checklist of everything still required before the account's application can be submitted: missing fields, missing documents and outstanding identity verifications.
- [Submit Application](https://docs.rolla.xyz/api-reference/endpoint/accounts/submit.md): Validates that the application is complete and submits it for review. Returns the outstanding items if anything is missing. For business accounts, every related person must have completed KYC before submission.
- [Update Business Details](https://docs.rolla.xyz/api-reference/endpoint/accounts/update-business.md): Updates the business application of a business account. Each provided section is merged into the stored data, so you can save progress incrementally. Applications can no longer be edited once submitted or approved.
- [Update Individual Details](https://docs.rolla.xyz/api-reference/endpoint/accounts/update-individual.md): Updates the KYC application of an individual account. Provided fields are merged into the stored data, so you can save progress incrementally. Applications can no longer be edited once submitted or approved.
- [Update Related Person](https://docs.rolla.xyz/api-reference/endpoint/accounts/update-related-person.md): Updates a related person on a business account's application. Provided fields are merged into the existing record.
- [Upload Document](https://docs.rolla.xyz/api-reference/endpoint/accounts/upload-document.md): Uploads a document to the account's application as `multipart/form-data`. Re-uploading the same document type replaces the previous file. Use `relatedPersonId` to attach the document to a specific related person.
- [Create Verification Token](https://docs.rolla.xyz/api-reference/endpoint/accounts/verification.md): Creates an identity verification (Sumsub WebSDK) access token for an individual account so the account holder can complete ID document upload and liveness checks in your app. Tokens expire after 30 minutes; request a new one when it expires. For business accounts, use the related-person KYC link ins…
- [Get Verification Status](https://docs.rolla.xyz/api-reference/endpoint/accounts/verification-status.md): Returns the identity verification status of an individual account holder.
- [List Banks](https://docs.rolla.xyz/api-reference/endpoint/banks.md): Returns a list of all Nigerian banks with their names and codes.
- [Create Beneficiary](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/create.md): Creates a new saved beneficiary for the business.
- [Delete Beneficiary](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/delete.md): Deletes a saved beneficiary.
- [Get Beneficiary](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/get.md): Retrieves a specific beneficiary by ID.
- [List Beneficiaries](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/list.md): Retrieves a paginated list of saved beneficiaries for the business.
- [Beneficiary Lookup](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/lookup.md): Validates a bank account and retrieves account holder details for beneficiary creation.
- [List Nigerian Banks](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/nigerian-banks.md): Returns a list of Nigerian banks for beneficiary creation. Same data as /banks.
- [Update Beneficiary](https://docs.rolla.xyz/api-reference/endpoint/beneficiaries/update.md): Updates an existing beneficiary's details.
- [Account Lookup](https://docs.rolla.xyz/api-reference/endpoint/lookup.md): Validates a bank account number and retrieves the account holder's name.
- [Assign Role to Member](https://docs.rolla.xyz/api-reference/endpoint/teams/assign-role.md): Assigns a role to an existing team member. Use `GET /teams/roles` to retrieve available role IDs.
- [Invite Team Member](https://docs.rolla.xyz/api-reference/endpoint/teams/invite.md): Sends an invitation to a new team member via email.
- [Get Team Members](https://docs.rolla.xyz/api-reference/endpoint/teams/members.md): Retrieves a paginated list of team members for the business.
- [Remove Team Member](https://docs.rolla.xyz/api-reference/endpoint/teams/remove-member.md): Removes a team member from the business. Cannot remove yourself or the business owner.
- [Get Available Roles](https://docs.rolla.xyz/api-reference/endpoint/teams/roles.md): Retrieves the list of available roles that can be assigned to team members.
- [Update Member Status](https://docs.rolla.xyz/api-reference/endpoint/teams/update-status.md): Activates or deactivates a team member. Only business owners can update member status.
- [Get Transactions](https://docs.rolla.xyz/api-reference/endpoint/transactions.md): Retrieves a paginated list of transactions with optional filtering.
- [Export Transactions](https://docs.rolla.xyz/api-reference/endpoint/wallet/export-transactions.md): Exports wallet transactions as a downloadable file with optional filtering.
- [Get Transaction Fee](https://docs.rolla.xyz/api-reference/endpoint/wallet/fee.md): Calculates the fee for a given transaction type, currency, and amount.
- [Get Transaction](https://docs.rolla.xyz/api-reference/endpoint/wallet/get-transaction.md): Retrieves details of a specific wallet transaction by ID.
- [Get Exchange Rates](https://docs.rolla.xyz/api-reference/endpoint/wallet/rates.md): Retrieves current exchange rates for supported currency pairs.
- [Get Statement](https://docs.rolla.xyz/api-reference/endpoint/wallet/statement.md): Retrieves wallet statement data for generating account statements.
- [Get Supported Currencies](https://docs.rolla.xyz/api-reference/endpoint/wallet/supported-currencies.md): Retrieves the list of currencies supported on the platform.
- [Swap Currency](https://docs.rolla.xyz/api-reference/endpoint/wallet/swap.md): Swaps funds from one currency to another at the current exchange rate.
- [Get Wallet Transactions](https://docs.rolla.xyz/api-reference/endpoint/wallet/transactions.md): Retrieves a paginated list of wallet transactions with optional filtering.
- [Rolla Transfer](https://docs.rolla.xyz/api-reference/endpoint/wallet/transfer.md): Send funds to another Rolla business instantly and fee-free. Identify the recipient by email, Rolla tag, or a saved beneficiaryId.
- [Get Virtual Accounts](https://docs.rolla.xyz/api-reference/endpoint/wallet/virtual-accounts.md): Retrieves virtual accounts for receiving payments.
- [Generate Dynamic Virtual Account](https://docs.rolla.xyz/api-reference/endpoint/wallet/virtual-accounts-generate.md): Generates a dynamic (one-time) NGN virtual account. If an active dynamic account already exists and hasn't expired, it will be returned instead.
- [Generate Static Virtual Account](https://docs.rolla.xyz/api-reference/endpoint/wallet/virtual-accounts-generate-static.md): Generates a permanent static NGN virtual account for your business. Only one static virtual account can exist — this will return an error if one already exists.
- [Get Wallets](https://docs.rolla.xyz/api-reference/endpoint/wallet/wallets.md): Retrieves all wallets for the authenticated business.
- [Withdraw Funds](https://docs.rolla.xyz/api-reference/endpoint/wallet/withdraw.md): Initiates a withdrawal from your wallet to a beneficiary. Either `beneficiaryId` or `inlineBeneficiary` must be provided. For USD international_wire, send as multipart/form-data and attach reference documents under the `documents` field.
- [Introduction](https://docs.rolla.xyz/api-reference/introduction.md): Rolla Developer API for programmatic transaction management
- [Delivery & Retries](https://docs.rolla.xyz/api-reference/webhooks/delivery.md): Retry behavior, idempotency, delivery logs, and manual replay
- [Events](https://docs.rolla.xyz/api-reference/webhooks/events.md): Webhook event types and the transaction lifecycle
- [Webhooks Overview](https://docs.rolla.xyz/api-reference/webhooks/overview.md): Receive real-time deposit and payout status updates instead of polling
- [Payloads](https://docs.rolla.xyz/api-reference/webhooks/payloads.md): Webhook payload schema and sample events for every transaction type
- [Signature Verification](https://docs.rolla.xyz/api-reference/webhooks/signatures.md): Verify that webhook events genuinely came from Rolla
- [Introduction](https://docs.rolla.xyz/index.md): Welcome to the Rolla Developer API documentation
- [Quickstart](https://docs.rolla.xyz/quickstart.md): Start making API calls in under 5 minutes
- [USD SWIFT Payouts](https://docs.rolla.xyz/swift-payouts.md): Country coverage, required beneficiary details, and IBAN requirements for sending USD payouts over SWIFT

## OpenAPI Specs

- [openapi](https://docs.rolla.xyz/api-reference/openapi.json)

## Optional

- [Dashboard](https://app.rolla.xyz)