Customers

First name of the customer. This is typically used for identification and personalization in communications.

Last name or surname of the customer. Combined with the first name to form the full legal name.

A valid and unique email address used to identify and contact the customer. It also serves as a primary login credential.

Customer’s active phone number, formatted in international standard (e.g., +233XXXXXXXXX). May be used for verification and notifications.

The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).

The type of customer account to create. Accepted values: 'individual' for personal accounts or 'business' for company accounts.

Unique identifier (UUID) assigned to the customer.

The customer’s given name.

The customer’s family name or surname.

Email address associated with the customer.

The type of customer account: ‘individual’ or ‘business’.

UUID of the company this customer belongs to.

UUID of the user or API client that created this customer.

Whether the customer account is currently active.

JSON string of additional metadata attached to the customer.

ISO 8601 timestamp when the customer was created.

ISO 8601 timestamp of the most recent update to the customer record.

The unique identifier of the customer you want to update

Customer's first name.

Customer's last name.

Customer's phone number in international format.

Customer's valid email address.

Unique identifier of the customer to be blacklisted. This is passed as a path parameter.

Set to true to blacklist the customer, or false to remove them from blacklist.

A globally unique identifier (UUID) that uniquely identifies the customer record in the system.

The first or given name of the customer. Used for display and personalization.

The surname or family name of the customer. Useful for full name generation.

A valid and unique email address associated with the customer. Used for communication and identification.

The customer's phone number in international format. Optional but can be used for verification or contact.

The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).

Indicates if the customer is blacklisted. A value of true means restricted from transactions.

Timestamp (ISO 8601 format) indicating when the customer was created in the system.

Timestamp (ISO 8601 format) of the most recent update made to the customer's profile.

An array of customer objects. Empty if no customers are found, but when present, contains detailed information about each customer.

Contains pagination information including current page, items per page, total item count, total page count, and flags for previous/next pages.

The current page number of the results.

The number of items returned per page.

Total number of customer items available.

Total number of pages available based on the current 'take' value.

Indicates whether there is a previous page of results available.

Indicates whether there is a next page of results available.

A system-generated universally unique identifier (UUID) for the customer. Used to reference the customer internally.

The customer’s given name. Typically used in user-facing communication or personalization.

The customer’s surname. Helpful for identity verification or formal communications.

The customer's unique email address, used for communication and login. Must follow standard email format.

The customer's mobile number in international format (e.g., +234xxxxxxxxx). Useful for two-factor authentication or support.

The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).

Boolean flag that indicates if the customer is blacklisted, true means they are blocked from certain actions.

Timestamp in ISO 8601 format indicating when the customer profile was first created.

Timestamp in ISO 8601 format marking the last time the customer profile was updated.