Get a subcustomer

Get subcustomer by ID or Email or Reference ID

get

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/v1/subcustomers/{subCustomerId}

Authorizations

ww-api-key

ww-api-keystringRequired

Path parameters

subCustomerIdstringRequired

Responses

default

default response

application/json

idstringRequired

Unique identifier for the subcustomer

namestringRequired

Name of the subcustomer

emailstringRequired

Email address of the subcustomer

countrystringOptional

ISO 3166-1 alpha-3 country code

statusall ofRequired

Status of the subcustomer

string · enumOptionalPossible values:

typeall ofRequired

Type of the subcustomer

string · enumOptionalPossible values:

onboardingStatusall ofRequired

Onboarding status of the subcustomer

string · enumOptionalPossible values:

businessIdstringRequired

Identifier of the business to which the subcustomer belongs

referenceIdstringOptional

The unique referenceId on your system representing the subcustomer

addressLine1stringOptional

Address line 1 of the subcustomer

addressLine2stringOptional

Address line 2 of the subcustomer

postalCodestringOptional

Postal code of the subcustomer

citystringOptional

City of the subcustomer

statestringOptional

State of the subcustomer

createdAtstring · date-timeRequired

Date and time when the subcustomer was created

updatedAtstring · date-timeRequired

Date and time when the subcustomer was last updated

get

/v1/subcustomers/{subCustomerId}

HTTPcURLJavaScriptPython

GET /v1/subcustomers/{subCustomerId} HTTP/1.1
Host: stage-capi.wewireafrica.com
ww-api-key: YOUR_API_KEY
Accept: */*

default

default response

{
  "id": "text",
  "name": "text",
  "email": "text",
  "country": "text",
  "status": "ACTIVE",
  "type": "INDIVIDUAL",
  "purpose": [
    "PAYOUT"
  ],
  "onboardingStatus": "DRAFT",
  "businessId": "text",
  "referenceId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "postalCode": "text",
  "city": "text",
  "state": "text",
  "createdAt": "2026-03-12T10:26:04.738Z",
  "updatedAt": "2026-03-12T10:26:04.738Z"
}