curl -X POST 'https://crypto-api.yativo.com/api/v1/customers/get-customers' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{}'
const customers = await sdk.customers.list({ page: 1, limit: 20 });
console.log(customers.data.customers);
{
"data": [
{
"_id": "cust_67d01994740754bbf304abcd",
"username": "alice_merchant",
"email": "alice@example.com",
"phone_number": "+1234567890",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-11T11:08:04.559Z",
"updatedAt": "2026-01-11T11:08:04.559Z"
},
{
"_id": "cust_67d2d2a5740754bbf308efgh",
"username": "bob_trader",
"email": "bob@example.com",
"phone_number": "",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-13T12:42:13.562Z",
"updatedAt": "2026-01-13T12:42:13.562Z"
}
],
"status": true
}
WaaS Customers (Wallet Sub-accounts)
List Customers
Retrieve a paginated list of all customers in your account
POST
/
v1
/
customers
/
get-customers
curl -X POST 'https://crypto-api.yativo.com/api/v1/customers/get-customers' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{}'
const customers = await sdk.customers.list({ page: 1, limit: 20 });
console.log(customers.data.customers);
{
"data": [
{
"_id": "cust_67d01994740754bbf304abcd",
"username": "alice_merchant",
"email": "alice@example.com",
"phone_number": "+1234567890",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-11T11:08:04.559Z",
"updatedAt": "2026-01-11T11:08:04.559Z"
},
{
"_id": "cust_67d2d2a5740754bbf308efgh",
"username": "bob_trader",
"email": "bob@example.com",
"phone_number": "",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-13T12:42:13.562Z",
"updatedAt": "2026-01-13T12:42:13.562Z"
}
],
"status": true
}
string
required
Bearer token:
Bearer YOUR_ACCESS_TOKENnumber
Page number for pagination. Default:
1number
Results per page. Default:
20, max: 100string
Filter by customer status. Accepted values:
active, suspended, pendingstring
Search by email or name (partial match supported).
string
Pass a specific customer ID to retrieve a single customer instead of the full list.
Response Type Definitions
Response Type Definitions
interface Customer {
id: string;
email: string;
first_name: string;
last_name: string;
status: "active" | "suspended" | "pending";
kyc_status: "not_started" | "pending" | "approved" | "rejected";
created_at: string;
updated_at: string;
}
interface ListCustomersResponse {
status: "success";
data: {
customers: Customer[];
pagination: {
page: number;
limit: number;
total: number;
total_pages: number;
};
};
}
curl -X POST 'https://crypto-api.yativo.com/api/v1/customers/get-customers' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{}'
const customers = await sdk.customers.list({ page: 1, limit: 20 });
console.log(customers.data.customers);
{
"data": [
{
"_id": "cust_67d01994740754bbf304abcd",
"username": "alice_merchant",
"email": "alice@example.com",
"phone_number": "+1234567890",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-11T11:08:04.559Z",
"updatedAt": "2026-01-11T11:08:04.559Z"
},
{
"_id": "cust_67d2d2a5740754bbf308efgh",
"username": "bob_trader",
"email": "bob@example.com",
"phone_number": "",
"user_id": "usr_6615c3a1e55d9ff7bc0a1234",
"createdAt": "2026-01-13T12:42:13.562Z",
"updatedAt": "2026-01-13T12:42:13.562Z"
}
],
"status": true
}
⌘I