Fetch all sub-customers

List all subcustomers

get
Authorizations
ww-api-keystringRequired
Query parameters
statusstring · enumOptional

Filter by subcustomer status

Possible values:
onboardingStatusstring · enumOptional

Comma-separated onboarding statuses (e.g., 'IN_REVIEW,APPROVED')

Possible values:
typestring · enumOptional

Filter by subcustomer type

Possible values:
countrystringOptional

ISO 3166-1 alpha-3 country code (e.g., USA, CAN)

purposestring · enumOptional

Filter by subcustomer purpose

Possible values:
Responses
200

200 response

application/json
get
/v1/subcustomers
GET /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