Customers

Overview

Customers represent individual or business entities that hold wallets and initiate transfers. They are the primary identity in the system and can be created with minimal information, supporting both widget-based flows and full KYC verification.

Create Customer

Create a new customer account. Supports both individual (cus_xxx) and business (biz_xxx) types.

Response:

{
  "id": "cus_abc123",
  "status": "approved",
  "createdAt": "2025-04-29T10:13:07.826Z"
}

Use Cases

When	What	Better For
Widget-based onramp flow	Create with empty object `{}`	Quick customer creation without KYC upfront
Full KYC verification	Create with customer data and `shareToken`	Importing existing KYC data from SumSub
Business customers	Set `type: "business"`	B2B applications requiring business accounts
Individual customers	Use default or `type: "individual"`	Consumer applications and personal wallets

List Customers

Retrieve all customers with optional filtering and pagination.

Use Cases

When	What	Better For
Displaying customer list	Use default pagination (`limit=20`)	Admin dashboards and customer management
Filtering by email	Add `email` query parameter	Finding specific customer by email address
Filtering by type	Add `type=individual` or `type=business`	Separating individual vs business customers
Large datasets	Use `offset` for pagination	Handling thousands of customers efficiently

Get Customer

Retrieve a specific customer by ID.

Use Cases

When	What	Better For
Single customer lookup	Use customer ID directly	Displaying customer details in UI
After customer creation	Fetch immediately after POST	Verifying customer was created successfully
Before operations	Check customer exists and status	Validating customer before transfers or wallets

Update Customer

Update customer information like phone, email, or KYC data.

Use Cases

When	What	Better For
KYC token refresh	Update with new `shareToken`	Crypto rails requiring fresh KYC verification
Profile updates	Update phone, email, address	Keeping customer information current
Partial updates	Send only changed fields	Efficient updates without full object replacement

Get Customer Balance

Retrieve balance information for a customer across all wallets.

Use Cases

When	What	Better For
Displaying balances	Fetch before showing wallet UI	Showing total balance across all chains
Balance reconciliation	Regular balance checks	Accounting and financial reporting
Before transfers	Verify sufficient balance	Preventing failed transfers due to low balance

Business Customer Operations

Business customers have dedicated endpoints for complete KYB (Know Your Business) management.

Create Business Customer

Create a business customer with full KYB information including documents and shareholders.

curl https://wallet.swipelux.com/v1/customers/business \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_API_KEY' \
  --data '{ ... }'

See Create Business Customer for complete documentation.

Update Business Customer

Update an existing business customer's KYB information.

curl https://wallet.swipelux.com/v1/customers/business/cus_abc123 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_API_KEY' \
  --data '{ "entityName": "New Name LLC" }'

See Update Business Customer for complete documentation.

Delete Business Customer

Delete a business customer and all associated data.

curl https://wallet.swipelux.com/v1/customers/business/cus_abc123 \
  --request DELETE \
  --header 'X-API-Key: YOUR_SECRET_API_KEY'

See Delete Business Customer for complete documentation.

Business Customer Use Cases

When	What	Better For
B2B onboarding	Create with full KYB data	Platforms requiring business verification
Business profile updates	PUT with changed fields	Updating company information
Account termination	DELETE business customer	Closing business accounts

Delete Customer

Delete a customer account. The customer ID can be reused after deletion.

Use Cases

When	What	Better For
GDPR compliance	Delete customer data	Handling data deletion requests
Account closure	Delete after transferring funds	Closing customer accounts permanently
Testing cleanup	Delete test customers	Maintaining clean test environments

On this page