# Partna API docs

## Docs

- [Complete Account Registration](https://docs.getpartna.com/api-reference/endpoint/v3/account/complete-account-registration.md): Complete a pending account registration request. This is used when merchant registration type is set to open
- [Create Account](https://docs.getpartna.com/api-reference/endpoint/v3/account/create-account.md): Create accounts.
- [Create Bank Account](https://docs.getpartna.com/api-reference/endpoint/v3/account/create-bank-account.md): Create bank account. You need to complete KYC before creating a bank account.
- [Get Account](https://docs.getpartna.com/api-reference/endpoint/v3/account/get-account.md): Get all accounts or filter using account name. The account name must be an alphanumeric lowercase hex string between 2 to 40 characters long
- [Get Account Permissions](https://docs.getpartna.com/api-reference/endpoint/v3/account/get-account-permissions.md): Get the valid permissions for accounts.
- [Get user Account Profile](https://docs.getpartna.com/api-reference/endpoint/v3/account/get-account-profile.md): Get user account profile.
- [Get Accounts Details](https://docs.getpartna.com/api-reference/endpoint/v3/account/get-accounts-details.md): Get accounts details.
- [Register Account](https://docs.getpartna.com/api-reference/endpoint/v3/account/register-account.md): Create a pending account registration request. This is used when merchant registration type is set to open
- [Search Account](https://docs.getpartna.com/api-reference/endpoint/v3/account/search-account.md): Search matching account names using at least 2 characters
- [Update Account Email](https://docs.getpartna.com/api-reference/endpoint/v3/account/update-account-email.md): Update account email.
- [Add IP to Whitelist](https://docs.getpartna.com/api-reference/endpoint/v3/admin/add-ip-to-whitelist.md): Add ip address(es) to the whitelist.
- [Get Whitelisted IPs](https://docs.getpartna.com/api-reference/endpoint/v3/admin/get-whitelisted-ips.md): Retrieve all whitelisted ip addresses for a merchant.
- [Remove IP from Whitelist](https://docs.getpartna.com/api-reference/endpoint/v3/admin/remove-ip-from-whitelist.md): Remove ip address from the whitelist.
- [Get Banks](https://docs.getpartna.com/api-reference/endpoint/v3/bank/get-banks.md): Get supported banks by currency.
- [Get Discounts](https://docs.getpartna.com/api-reference/endpoint/v3/discount/get-discounts.md): Get discounts applied on USD-NGN offramp transaction rates based on the transaction amount.
- [Check for manual kyc ](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/check-for-manual-kyc.md): Checks if the merchant is exempt from KYC requirements.
- [Confirm KYC OTP](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/confirm-kyc-otp.md): Confirm KYC verification OTP.
- [Confirm Phone](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/confirm-phone.md): Confirm phone number associated with account BVN.
- [Handle BVN OTP Method](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/handle-bvn-otp-method-1.md): Choose BVN verification method.
- [Initiate BVN KYC](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/initiate-bvn-kyc.md): Initiate account KYC with BVN.
- [Initiate user's phone number validation by country](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/initiate-users-phone-number-validation-by-country.md): Initiate user's phone number validation by country
- [Merchant KYC users manually](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/merchant-kyc-users-manually.md): Allows a merchant to manually populate KYC information for their members.
- [Resolve Bank](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/resolve-bank.md): Resolve bank account by account number and bank code.
- [Supported Verification Methods by country](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/supported-verification-methods-by-country.md): Get supported KYC verification methods by country.
- [Used to get a user's verified phone numbers by country](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/used-to-get-a-users-verified-phone-numbers-by-country.md): Used to get a user's verified phone numbers by country.
- [Validate a user's phone number](https://docs.getpartna.com/api-reference/endpoint/v3/kyc/validate-a-users-phone-number.md): Validate a user's phone number
- [Disable Account MFA](https://docs.getpartna.com/api-reference/endpoint/v3/mfa/disable-account-mfa.md): Disable account MFA.
- [Enable Account MFA](https://docs.getpartna.com/api-reference/endpoint/v3/mfa/enable-account-mfa.md): Initiate account MFA enrollment.
- [Get Account MFA](https://docs.getpartna.com/api-reference/endpoint/v3/mfa/get-account-mfa.md): Get account MFA details.
- [Validate Account MFA](https://docs.getpartna.com/api-reference/endpoint/v3/mfa/validate-account-mfa.md): Complete account MFA enrollment.
- [Mock Deposit](https://docs.getpartna.com/api-reference/endpoint/v3/mock/mock-deposit.md): Mock crypto and fiat deposit.
- [Mock Fiat Deposit](https://docs.getpartna.com/api-reference/endpoint/v3/mock/mock-fiat-deposit.md): Mock fiat deposit.
- [Get Pending Pricing](https://docs.getpartna.com/api-reference/endpoint/v3/pricing/get-pending-pricing.md): Get pending pricing.
- [Pricing Alert](https://docs.getpartna.com/api-reference/endpoint/v3/pricing/pricing-alert.md): Trigger pricing reminder, charge, retry or receipt.
- [Calculate ramp fees from toAmount or fromAmount](https://docs.getpartna.com/api-reference/endpoint/v3/ramp/calculate-ramp-fees-from-toamount-or-fromamount.md): Calculate ramp fees from toAmount or fromAmount
- [Get Ramp Requests](https://docs.getpartna.com/api-reference/endpoint/v3/ramp/get-ramp-requests.md): Gets ramp requests.
- [Onramp and Offramp](https://docs.getpartna.com/api-reference/endpoint/v3/ramp/onramp-and-offramp.md): Initiates onramp and offramp requests.
- [Create a custom ratekey for conversion](https://docs.getpartna.com/api-reference/endpoint/v3/rate/create-a-custom-ratekey-for-conversion.md): Create a custom rate key to complete a conversion transaction.
- [Get Rate](https://docs.getpartna.com/api-reference/endpoint/v3/rate/get-rate.md): Get Rate details.
- [Verify Rate Key](https://docs.getpartna.com/api-reference/endpoint/v3/rate/verify-rate-key.md): Verify Rate Key.
- [Get Supported Assets](https://docs.getpartna.com/api-reference/endpoint/v3/supported/get-supported-assets.md): Get a list of supported assets including symbols, contract details, withdrawal constraints, and transaction explorer links.
- [Convert Currency](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/convert-currency.md): Convert between currencies.
- [Create Transfer](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/create-transfer.md): Create transfer.
- [Get Single Transaction](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/get-single-transaction.md): Get single transaction by reference.
- [Get Transfer](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/get-transfer.md): Get transactions.
- [Initiate Transfer](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/initiate-transfer.md): Initiate transfer for KES or GHS. This is not required for NGN.
- [Withdraw](https://docs.getpartna.com/api-reference/endpoint/v3/transfer/withdraw.md): Initiate withdrawal.
- [Create User](https://docs.getpartna.com/api-reference/endpoint/v3/user/create-user.md): Create and activate user accounts.
- [Delete API Key](https://docs.getpartna.com/api-reference/endpoint/v3/user/delete-api-key.md): Delete user API key.
- [Delete Webhook URL](https://docs.getpartna.com/api-reference/endpoint/v3/user/delete-webhook-url.md): Delete user webhook URL.
- [Generate API Key](https://docs.getpartna.com/api-reference/endpoint/v3/user/generate-api-key.md): Generate user API keys.
- [Get API Key scopes](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-api-key-scopes.md): Get the valid scopes for API jey generation.
- [Get API Keys](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-api-keys.md): Get user API keys.
- [Get Balances](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-balances.md): Get merchant and customer balances.
- [Get Customer's Account Profile](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-customers-account-profile.md): Get customer's account profile.
- [Get Registration, Deposit and Fee Settings](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-registration-deposit-and-fee-settings.md): Get preferred registration type, fee settings, deposit account, and crypto payment source.
- [Get Webhook URL](https://docs.getpartna.com/api-reference/endpoint/v3/user/get-webhook-url.md): Get user webhook URL.
- [Invalidate API Key](https://docs.getpartna.com/api-reference/endpoint/v3/user/invalidate-api-key.md): Invalidate user API key.
- [Registration, Deposit and Fee Settings](https://docs.getpartna.com/api-reference/endpoint/v3/user/registration-deposit-and-fee-settings.md): Update preferred registration type, fee settings, deposit account, and crypto payment source.
- [Update User](https://docs.getpartna.com/api-reference/endpoint/v3/user/update-user.md): Update user endpoint ID and callback URL.
- [Update Webhook URL](https://docs.getpartna.com/api-reference/endpoint/v3/user/update-webhook-url.md): Update user webhook URL.
- [Used to delete an admin with privileges](https://docs.getpartna.com/api-reference/endpoint/v3/user/used-to-delete-an-admin-with-privileges.md): Used to delete an admin with privileges.
- [Used to get all active admins with privileges](https://docs.getpartna.com/api-reference/endpoint/v3/user/used-to-get-all-active-admins-with-privileges.md): Used to get all active admins with privileges.
- [Used to give admin privileges.](https://docs.getpartna.com/api-reference/endpoint/v3/user/used-to-give-admin-privileges.md): The first value of the roles array should be 'admin' followed by other permissions (view, operation, settings)
- [API Reference](https://docs.getpartna.com/v4/api-reference/overview.md): Complete reference for all Partna API endpoints
- [Authentication](https://docs.getpartna.com/v4/documentation/authentication.md): Authenticate your API requests with API keys
- [Errors](https://docs.getpartna.com/v4/documentation/core-concepts/errors.md): HTTP status codes and error response format
- [Rates and Fees](https://docs.getpartna.com/v4/documentation/core-concepts/rates-and-fees.md): Conversion rates, rate keys, and volume-based discounts
- [Testing](https://docs.getpartna.com/v4/documentation/core-concepts/testing-1.md): Test your integration with mock transactions in staging
- [Webhooks](https://docs.getpartna.com/v4/documentation/core-concepts/webhooks.md): Receive real-time notifications for transaction and verification events
- [Environments](https://docs.getpartna.com/v4/documentation/environments.md): Staging and production base URLs
- [Accounts and KYC](https://docs.getpartna.com/v4/documentation/guides/accounts-and-kyc.md): Create user accounts and verify identity
- [Collect and Settle](https://docs.getpartna.com/v4/documentation/guides/collect-and-settle.md): Collect local currency payments and settle in USD or stablecoins
- [Offramp](https://docs.getpartna.com/v4/documentation/guides/offramp.md): Let your users convert crypto to local currency
- [Offramp Widget](https://docs.getpartna.com/v4/documentation/guides/offramp-widget.md): Redirect users to Partna's offramp widget
- [Onramp](https://docs.getpartna.com/v4/documentation/guides/onramp.md): Let your users convert local currency to crypto
- [Onramp Widget](https://docs.getpartna.com/v4/documentation/guides/onramp-widget.md): Redirect users to Partna's onramp widget
- [Introduction](https://docs.getpartna.com/v4/documentation/introduction.md): Stablecoin-powered payment infrastructure for Africa
- [Quickstart](https://docs.getpartna.com/v4/documentation/quickstart.md): Make your first API call in under 5 minutes

## OpenAPI Specs

- [partna](https://docs.getpartna.com/api-reference/partna.json)
- [ventogram](https://docs.getpartna.com/api-reference/ventogram.yml)
- [openapi](https://docs.getpartna.com/api-reference/openapi.json)
- [biz](https://docs.getpartna.com/api-reference/biz.yml)