> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blips.network/llms.txt
> Use this file to discover all available pages before exploring further.

# List customers

> List customers for the current platform scope. This operation is part of the current public API walkthrough.



## OpenAPI

````yaml /openapi/blips-public-reference.yaml get /customers
openapi: 3.1.0
info:
  title: BLIPS Public Reference API
  version: '2026-04-08'
  description: >-
    Public OpenAPI 3.1 subset for the first BLIPS Mintlify API Reference and
    Playground release. This document is bound to the confirmed Public Test
    Backend at https://public-test.blips.network, includes only the approved
    first-release public endpoints, uses only internal `$ref` values, and
    excludes callback-only webhook documentation and operator-only surfaces.
servers:
  - url: https://public-test.blips.network
    description: >-
      Confirmed Public Test Backend ingress target for public BLIPS API
      Reference, Playground, and internet-testable Try It flows.
security:
  - BasicAuth: []
tags:
  - name: Platform Setup
    description: >-
      Bootstrap and platform configuration surfaces for establishing the public
      BLIPS integration context.
  - name: Sandbox API
    description: >-
      Sandbox-only externally displayed helper surfaces. These routes either
      adjust quote inputs or create incoming-payment review cases, but they
      always feed the existing quote or transaction families and never become
      second outward API families.
  - name: Tokens
    description: >-
      Platform-scoped API credential create, list, detail, and revoke
      operations.
  - name: Customers
    description: >-
      Customer onboarding, profile lifecycle, and PPV payment-address issuance
      surfaces.
  - name: Accounts
    description: >-
      Customer-bound internal-account and external-account surfaces kept in the
      first-layer public contract.
  - name: Same-Currency Transfers
    description: >-
      Same-currency receiver lookup plus incoming and outgoing transfer
      primitives.
  - name: Cross-Currency Transfers
    description: >-
      PPV-first receiver lookup, quote creation/readback, and quote execution
      for cross-currency flows.
  - name: Transactions
    description: Transaction readback plus bounded incoming-review decision operations.
  - name: Webhooks
    description: >-
      Webhook connectivity verification surface for the public BLIPS
      integration.
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        List customers for the current platform scope. This operation is part of
        the current public API walkthrough.
      operationId: listCustomers
      parameters:
        - name: platformCustomerId
          in: query
          required: false
          schema:
            type: string
        - name: customerType
          in: query
          required: false
          schema:
            type: string
            enum:
              - INDIVIDUAL
              - ENTITY
        - name: kycStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - APPROVED
              - REJECTED
        - name: ppvAddress
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Customer list returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListResponse'
              examples:
                default:
                  value:
                    data:
                      - id: cust_123
                        platformId: plat_demo_001
                        platformCustomerId: partner_cust_001
                        customerType: INDIVIDUAL
                        fullName: Demo Customer
                        ppvAddress: demo-customer@pay.example.blips
                        kycStatus: APPROVED
                        createdAt: '2026-03-26T09:00:00Z'
                        updatedAt: '2026-03-26T09:00:00Z'
                    hasMore: false
                    nextCursor: null
                    totalCount: 1
components:
  schemas:
    CustomerListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        totalCount:
          type: integer
      required:
        - data
        - hasMore
        - nextCursor
        - totalCount
      additionalProperties: false
    Customer:
      type: object
      properties:
        id:
          type: string
        platformId:
          type: string
        platformCustomerId:
          type: string
        customerType:
          type: string
          enum:
            - INDIVIDUAL
            - ENTITY
        fullName:
          type: string
        birthDate:
          type: string
          format: date
        address:
          $ref: '#/components/schemas/CustomerAddress'
        ppvAddress:
          type:
            - string
            - 'null'
          description: Public PPV address in plain `localPart@ppvDomain` format.
        kycStatus:
          type: string
          enum:
            - PENDING
            - APPROVED
            - REJECTED
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - platformId
        - platformCustomerId
        - customerType
        - kycStatus
        - createdAt
        - updatedAt
      additionalProperties: true
    CustomerAddress:
      type: object
      description: Customer address object.
      properties:
        line1:
          type: string
          description: Street address line for the customer.
        line2:
          type: string
          description: Street address line 2 when present on the customer record.
        city:
          type: string
          description: City for the customer address.
        state:
          type: string
          description: State, province, or region for the customer address.
        postalCode:
          type: string
          description: Postal or ZIP code for the customer address.
        country:
          type: string
          description: Two-letter country code or equivalent supported country value.
      additionalProperties: false
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Integration-key Basic Auth (`clientId:clientSecret`) as documented in
        docs/public/AUTHENTICATION.md.

````