---
title: "List your sub-customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# List your sub-customers

`GET /v1/customers`

## Request

- Base URL: `https://api.sandbox.alfredpay.io`
- URL: `https://api.sandbox.alfredpay.io/v1/customers`
- Auth: one of:
  - HTTP bearer
  - API key in header `api-key` and API key in header `api-secret`

Returns every customer this partner has onboarded. The list is scoped by your API key, so you need no parameter to see your own book and you can never see another partner's.

## Query parameters

- `limit` integer
- `cursor` string
- `status` 'NOT_STARTED' | 'INCOMPLETE' | 'AWAITING_UBO' | 'AWAITING_QUESTIONNAIRE' | 'UNDER_REVIEW' | 'ACTIVE' | 'PAUSED' | 'REJECTED' | 'OFFBOARDED'
- `type` 'INDIVIDUAL' | 'BUSINESS'

## Response `200`

OK

- object
  - `has_more` boolean
  - `next_cursor` string, nullable
  - `data` Customer[]
    - `customerType` 'CUSTOMER' | 'THIRD_PARTY_CUSTOMER' | 'SUB_CUSTOMER'
    - `accountType` 'PARTNER' | 'DIRECT_CUSTOMER'
    - `customerArchetypes` CustomerArchetype[]
    - `useCases` UseCase[]
    - `kycRelianceModel` 'FULL_RELIANCE' | 'SEMI_RELIANCE' | 'NON_RELIANCE'
    - `legalName` string
    - `tradeNameDba` string
    - `businessType` string
    - `businessDescription` string
    - `incorporationCountry` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `incorporationDate` string, date
    - `businessRegistrationNumber` string
    - `residencyCountry` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `industryCodes` string[]
    - `websiteUrls` string[]
    - `registeredAddress` Address
      - `street1` string
      - `street2` string, nullable
      - `city` string
      - `state` string
      - `zipCode` string
      - `country` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `physicalAddress` Address
      - `street1` string
      - `street2` string, nullable
      - `city` string
      - `state` string
      - `zipCode` string
      - `country` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `mailingAddress` Address
      - `street1` string
      - `street2` string, nullable
      - `city` string
      - `state` string
      - `zipCode` string
      - `country` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `taxAddress` Address
      - `street1` string
      - `street2` string, nullable
      - `city` string
      - `state` string
      - `zipCode` string
      - `country` 'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY': ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound `country` value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → `422 validation_error`.
    - `email` string, email
    - `phone` string
    - `accountPurposes` AccountPurpose[]
    - `accountPurposeOther` string
    - `sourceOfFunds` string
    - `sourceOfFundsDescription` string
    - `sourceOfWealth` string
    - `expectedMonthlyVolumeUsd` string
    - `expectedTransactionCount` integer
    - `operatingCountries` CountryCode[]
    - `destinationOfFunds` string
    - `counterpartyRelationship` string
    - `ownFundsVsClientFunds` 'OWN_FUNDS' | 'CLIENT_FUNDS' | 'BOTH'
    - `actsOnOwnBehalf` boolean
    - `regulatedActivity` boolean
    - `highRiskActivities` string[]
    - `highRiskActivitiesExplanation` string
    - `prohibitedJurisdictionExposure` boolean
    - `controlPersonRequired` boolean
    - `declaredFinancialsCurrency` 'USD' | 'HKD' | 'CNY' | 'MXN' | 'DOP' | 'COP' | 'BRL' | 'ARS' | 'CLP' | 'PEN' | 'BOB' | 'PYG' | 'USDC' | 'USDT': Fourteen members, reconciled to the countries a customer can be onboarded in. USDC and USDT are stablecoins and require `chain`.
    - `acceptTos` boolean
    - `id` string, required
    - `type` 'INDIVIDUAL' | 'BUSINESS', required
    - `status` 'NOT_STARTED' | 'INCOMPLETE' | 'AWAITING_UBO' | 'AWAITING_QUESTIONNAIRE' | 'UNDER_REVIEW' | 'ACTIVE' | 'PAUSED' | 'REJECTED' | 'OFFBOARDED', required
    - `name` string
    - `pauseReason` string, nullable: Why the customer is paused. Null unless status is PAUSED.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time

## Other responses

- `401`: Missing or invalid credentials.

## Changes

- **2026-11-03** `20fef4fd2ab3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/changes/v1/customers/get.md)

---

[API](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation.md) - [All operations](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/revisions/20fef4fd2ab3?raw)