# Edge API Documentation

## Docs

- [Overview](https://doc.withedge.co/api-reference/accounts.md): Edge's account management api service
- [Overview](https://doc.withedge.co/api-reference/authentication.md): Overview page to integrating Edge apis
- [Overview](https://doc.withedge.co/api-reference/customers.md): The Customer Service offers a comprehensive solution for organizations to efficiently manage their customer relationships. This service is designed to enhance the customer onboarding process, provide seamless account creation, and ensure compliance with regulatory requirements through Know Your Cust…
- [Get Account Details](https://doc.withedge.co/api-reference/playground/accounts/regular/account_details.md): This endpoint enables you to retrieve the details of a specific bank account.
- [Get Account Statement](https://doc.withedge.co/api-reference/playground/accounts/regular/account_statement.md): This enables you to retrieve the statement of a customer's account.
- [Corporate Account](https://doc.withedge.co/api-reference/playground/accounts/regular/create_corp_account.md): This endpoint is used to create corporate accounts in favour of your business customers.
- [Personal Account](https://doc.withedge.co/api-reference/playground/accounts/regular/create_personal_account.md): Use this endpoint to create a personal bank account for individual customers. You can specify the account type or let it default to savings.
- [Freeze/Unfreeze Account](https://doc.withedge.co/api-reference/playground/accounts/regular/freeze_account.md): This endpoint is used to send a request to freeze or unfreeze a customer's account.
- [Get All Accounts](https://doc.withedge.co/api-reference/playground/accounts/regular/get_accounts.md): This endpoint enables you to retrieve all the bank accounts generated by you.
- [Close/Re-Open Account](https://doc.withedge.co/api-reference/playground/accounts/shared/close_accounts.md): This endpoint is used to send a request to close or re-open a customer's account.
- [Get Account Details](https://doc.withedge.co/api-reference/playground/accounts/virtual/account_details.md): This enables you to retrieve the details of a specific account you had previously generated.
- [Dedicated Account](https://doc.withedge.co/api-reference/playground/accounts/virtual/create_dedicated_account.md): This endpoint is used to create a dedicated virtual account for a specific customer on the Edge platform.
- [Dynamic Account](https://doc.withedge.co/api-reference/playground/accounts/virtual/create_dynamic_account.md): This endpoint allows you to create a dynamic virtual account with customizable expiry time or expiry date.
- [Get All Accounts](https://doc.withedge.co/api-reference/playground/accounts/virtual/get_accounts.md): This endpoint enables you to retrieve all the virtual accounts generated by you.
- [Reverse Funds](https://doc.withedge.co/api-reference/playground/accounts/virtual/initiate_reversal.md): This endpoint is used to reverse the latest collection into a dynamic virtual account.
- [Sweep Collection](https://doc.withedge.co/api-reference/playground/accounts/virtual/sweep.md): This allows you to sweep funds out of any of your profiled pool accounts into your profiled corporate account.
- [Transaction History](https://doc.withedge.co/api-reference/playground/accounts/virtual/transaction_hist.md): This endpoint enables you to retrieve the transaction history for a virtual account generated by you.
- [Get Access Token](https://doc.withedge.co/api-reference/playground/auth/get_token.md)
- [Revoke Token](https://doc.withedge.co/api-reference/playground/auth/revoke_token.md): This endpoint is used to invalidate your current active bearer token
- [Customer KYC Update](https://doc.withedge.co/api-reference/playground/customer/customerKYC.md): This endpoint enables you to update an existing customer's KYC tier.
- [Get Customer](https://doc.withedge.co/api-reference/playground/customer/get_customer.md): This endpoint enables you to retrieve the details of a specific customer that you have generated on the Edge platform.
- [Get All Customers](https://doc.withedge.co/api-reference/playground/customer/get_customers.md): This endpoint enables you to retrieve all customers you have successfully created.
- [Profile Business](https://doc.withedge.co/api-reference/playground/customer/profile_business.md): This endpoint enables you to profile a business.
- [Profile Individual](https://doc.withedge.co/api-reference/playground/customer/profile_customer.md): This endpoint enables you to profile an individual.
- [Enable/Disable Customer](https://doc.withedge.co/api-reference/playground/customer/toggle_customer.md): This endpoint enables you to disable or enable any of your existing customer's profile.
- [Validate BVN](https://doc.withedge.co/api-reference/playground/kyc/bvn.md): This endpoint enables you to validate a customer's Bank Verification Number (BVN).
- [Validate BVN against NIN data](https://doc.withedge.co/api-reference/playground/kyc/bvn_nin.md): This endpoint enables you to validate a customer's BVN against their NIN data.
- [Verify Company CAC](https://doc.withedge.co/api-reference/playground/kyc/cac.md): This endpoint enables you to verify a company's CAC (Corporate Affairs Commission) information.
- [Validate BVN](https://doc.withedge.co/api-reference/playground/kyc/cac_advanced.md): This endpoint enables you to validate a customer's Bank Verification Number (BVN).
- [Verify Identity Document](https://doc.withedge.co/api-reference/playground/kyc/identity_doc.md): This endpoint enables you to verify an identity document for authenticity.
- [Verify Identity Document with Face](https://doc.withedge.co/api-reference/playground/kyc/identity_doc_wface.md): This endpoint enables you to verify an identity document against a selfie image for identity confirmation.
- [Validate NIN](https://doc.withedge.co/api-reference/playground/kyc/nin.md): This endpoint enables you to validate a customer's National Identity Number (NIN).
- [Verify Company TIN](https://doc.withedge.co/api-reference/playground/kyc/tin.md): This endpoint enables you to verify a company's Tax Identification Number (TIN).
- [Check Status](https://doc.withedge.co/api-reference/playground/transfers/check_status.md): This allows you check the real-time status of a processed transaction
- [Collection Account Transfer](https://doc.withedge.co/api-reference/playground/transfers/collection_transfer.md): This endpoint allows you to initiate a transfer request directly from one of your Edge collection accounts.
- [Initiate Customer Transfer Request](https://doc.withedge.co/api-reference/playground/transfers/customer_transfer.md): This endpoint allows you to initiate a transfer request on behalf of your customer.
- [Retrieve Active Banks](https://doc.withedge.co/api-reference/playground/transfers/get_banks.md): This allows you to retrieve a list of active banks eligible for fund transfers.
- [Name Enquiry](https://doc.withedge.co/api-reference/playground/transfers/name_enquiry.md): This endpoint allows you to validate the name on an account.
- [Validate Customer Transfer Request](https://doc.withedge.co/api-reference/playground/transfers/process_transfer.md): This endpoint allows you to validate a transfer request using the provided OTP.
- [Request OTP](https://doc.withedge.co/api-reference/playground/util/req_otp.md): This endpoint generates a One-Time Password (OTP) and sends it to the phone number linked to the provided account number.
- [Validate OTP](https://doc.withedge.co/api-reference/playground/util/val_otp.md): This endpoint allows you to validate a transfer request using the provided OTP.
- [Overview](https://doc.withedge.co/api-reference/transfers.md): The Transfer Services API enables seamless money transfers between accounts within the same bank or to accounts in other banks.
- [Authentication](https://doc.withedge.co/home/authentication.md): To interact with the Edge API, you’ll need to authenticate your requests using a token. This token is generated from your API credentials and is required for all API calls.
- [Data Encryption](https://doc.withedge.co/home/encryption.md): When interacting with the Edge API, understanding how data is secured is crucial. Depending on the environment—production or sandbox—the encryption protocols differ, affecting how you handle API requests and responses.
- [Environment](https://doc.withedge.co/home/environments.md): When integrating with the Edge API, understanding the different environments available is crucial for smooth development and deployment. Edge provides two distinct environments—**Sandbox** and **Production**—each tailored for specific stages of your integration process. This guide will walk you thro…
- [Pricing](https://doc.withedge.co/home/fees.md): Understand Edge's pricing structure and learn how to optimize your usage based on your business needs.
- [Idempotency](https://doc.withedge.co/home/idempotency.md): Idempotency ensures that multiple identical requests to the Edge API have the same effect as making a single request. This is crucial for operations like payments or customer creation, where duplicate processing due to retries could cause unintended consequences, such as charging a customer multiple…
- [Introduction](https://doc.withedge.co/home/introduction.md): Welcome to Edge API documentation. Let's get started by making Edge yours.
- [Onboarding Checklist](https://doc.withedge.co/home/live/checklist.md): Follow this checklist to complete your onboarding on Edge, from signing up to linking your corporate bank account.
- [Compliance](https://doc.withedge.co/home/live/compliance.md): To use Edge, businesses must meet certain **compliance requirements** to ensure the security and integrity of the platform. Compliance is crucial for maintaining trust, adhering to regulatory standards, and ensuring the protection of both user and business data.
- [Going Live on Edge](https://doc.withedge.co/home/live/going-live.md): Prepare your application to go live on Edge. Follow these pre-going live activities to ensure a smooth transition from sandbox to production.
- [Security](https://doc.withedge.co/home/live/security.md): Security is critical when integrating with Edge, ensuring that your data and the data of your users are protected at every step. Follow these security guidelines and best practices to safeguard your integration and maintain a secure connection with Edge.
- [Onboarding](https://doc.withedge.co/home/onboarding.md): Get started with Edge—your all-in-one API Banking platform. Follow these steps to quickly set up your account and start integrating financial services into your business.
- [Response Codes](https://doc.withedge.co/home/response.md): When working with the Edge API, you will encounter various response codes that indicate the outcome of your requests. These codes follow the ISO 8583 standard, commonly used in financial transactions. Understanding these codes is essential for handling API responses effectively.
- [Webhook](https://doc.withedge.co/home/webhook.md): Webhooks are a powerful feature that allows your application to receive real-time notifications about specific events that occur within the Edge platform. By setting up webhooks, you can automate processes, update records, and trigger workflows in your application as soon as an event happens.

## OpenAPI Specs

- [openapi](https://doc.withedge.co/api-reference/openapi.json)
- [edge-auth](https://doc.withedge.co/edge/edge-auth.json)