API Key Auth

Customer KYC Face_NIN

x-api-key

Embedly API Documentation

API Reference

Get Started

Join The Community

Get started with the Embedly API and explore detailed endpoint documentation with interactive playgrounds.

Overview

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 Customer (KYC) procedures.

This endpoint enables you to add a customer

Add Customers

This endpoint enables you to create a customer profile

Create Customer

This endpoint retrieves customer  using their unique identifier

Get Customer by ID

This endpoint enables you to retrieve all customers you have successfully created.

Get All Customers

This endpoint enables you to retrieve the Id of a specific customer.

Get All Customer types

This endpoint is used to update a customer's name

Update Customer Name

The Product API serves as a comprehensive solution for managing product information, enabling users to add, update, delete, and retrieve products effectively. This API ensures that product data is always current and accessible.

The endpoint allows you to to create a new product.

Create new product

The endpoint allows you to retrieve a list of products.

List of all products

The endpoint allows you to update an existing product..

Update existing Product

The endpoint allows you to activate a product by its ID.

Activate Product by its ID

The endpoint allows you to deactivate a product by its ID.

Deactivate Product by its ID

The ProductLimit API defines and manages transaction limits associated with products, allowing organizations to set and update limits based on customer and currency. This API helps ensure compliance and effective risk management.

The endpoint allows you to retrieve limits for a specific product and currency.

Retrieve Limit of a product and Currency

The endpoint allows you to retrieve limits for a specific product and currency for a given customer.

Limit for Customer

The endpoint allows you to retrieve the default transaction limits

Default transaction limits

The endpoint allows you to to add limits for a specific customer.

Limit Customer

The endpoint allows you to update default transaction limits..

Update default transaction limit

The endpoint allows you to update an existing product limit

Add Limit to existing Product

The endpoint allows you to add limits for a specific customer.

Customer Limit

The Wallet Service provides organizations with a seamless and efficient solution for creating and managing customer wallets.

Wallet Overview

The endpoint is designed to create a new wallet for a customer.

Add Wallet

The endpoint allows you to close a specified wallet using the account number and associated details.

Close Wallet

The endpoint displays the transaction history for a specific wallet within an organization over a specified time range.

Wallet History

The endpoint retrieves the transaction history for a specific account number over a specified time range

Retrieve transaction history for an account number

The endpoint checks if a specified wallet can be closed based on the account ID..

Close Wallet by AccountID

The endpoint allows you to search for a wallet associated with a specified email address.

Search Wallet by Email

The endpoint allows you to search for a wallet associated with a specified mobile number.

Search Wallet by Mobile

The endpoint retrieves the details of a specific wallet associated with a customer using their unique identifiers.

Retrieve Detail of a Specific Wallet

The endpoint allows you to retrieves the details of a specific wallet associated with a customer.

Retrieve Wallet Detail

The endpoint allows you to retrieves the reasons available for closing an account.

Account Closure

The endpoint retrieves the details of a specific wallet using its unique wallet ID.

Retrieve Wallet by ID

The endpoint posts a transaction to a specified wallet using the account number..

Post Wallet Transaction

The endpoint allows you to completes a specified wallet transaction.

Complete Wallet Transaction

The endpoint allows you to reverse a specified wallet transaction.

Reverse Transaction

The endpoint facilitates transferring funds from one wallet to another.

Restrict Wallet

The endpoint restricts a specified wallet based on the account ID and restriction type.

Restrict by AccountID

The endpoint restricts a specified wallet by updating its details.

The Wallet Group API facilitates the organization of multiple wallets into groups, allowing for better management and oversight. This API supports the creation and modification of wallet groups to enhance user experience.

The endpoint allows you to create a new wallet group.

Add WalletGroup

The endpoint allows you to add a wallet to a specified wallet group.

Add Wallet to WalletGroup

The endpoint allows you to add a feature to a specified wallet group.

Add WalletGroup Feature

The endpoint retrieves a list of available WalletGroup features..

WalletGroup Feature

The endpoint allows you to retrieves details of a specified wallet group using its ID.

WalletGroup ID

The endpoint retrieves a list of all wallet groups.

Get WalletGroup

Enable your customer transfer funds to any nigerian financial institution.

Payout

Endpoint for retrieving banks available for processing transfers to and their respective bank codes.