Fetch all sub-customers
Authorizations
ww-api-keystringRequired
Query parameters
statusstring · enumOptionalPossible values:
Filter by subcustomer status
onboardingStatusstring · enumOptionalPossible values:
Comma-separated onboarding statuses (e.g., 'IN_REVIEW,APPROVED')
typestring · enumOptionalPossible values:
Filter by subcustomer type
countrystringOptional
ISO 3166-1 alpha-3 country code (e.g., USA, CAN)
purposestring · enumOptionalPossible values:
Filter by subcustomer purpose
Responses
200
200 response
application/json
get
/v1/subcustomersGET /v1/subcustomers HTTP/1.1
Host: capi.wewireafrica.com
ww-api-key: YOUR_API_KEY
Accept: */*
200
200 response
{
"data": [
{
"id": "text",
"name": "text",
"email": "text",
"country": "text",
"status": "ACTIVE",
"type": "INDIVIDUAL",
"purpose": [
"PAYOUT"
],
"onboardingStatus": "DRAFT",
"onboardingId": "text",
"businessId": "text",
"addressLine1": "text",
"addressLine2": "text",
"postalCode": "text",
"city": "text",
"state": "text",
"createdAt": "2025-11-29T11:25:57.461Z",
"updatedAt": "2025-11-29T11:25:57.461Z"
}
],
"totalItems": 1,
"totalPages": 1,
"currentPage": 1,
"pageSize": 1
}Last updated