---
title: "Search customers"
method: GET
path: "/platform/v2/customers"
tags: ["Customers"]
---

# Search customers

`GET /platform/v2/customers`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v2/customers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v2/customers/get.ts> (a function with typed inputs; its response is checked against the schema)

Searches customers associated with the caller's account, with optional filters and pagination.

## Query parameters

- `name` string
- `statuses` string[]
- `types` string[]
- `models` string[]
- `useCases` string[]
- `reference` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Paginated list of customers

- V2PaginatedCustomerSummaryResponse
  - `totalElements` integer
  - `totalPages` integer
  - `content` V2CustomerSummaryResponse[]
    - `id` string, uuid
    - `reference` string
    - `status` 'AGREEMENTS_PENDING' | 'INFO_REQUIRED' | 'PENDING' | 'ACTIONS_REQUIRED' | 'VERIFIED' | 'REJECTED' | 'TERMINATED': Customer onboarding status: - `AGREEMENTS_PENDING`: The customer was created through [pre-customer agreements](/bvnk/api-explorer/endpoints/create-pre-customer-agreements-v-2) and the agreements are not yet signed. - `INFO_REQUIRED`: Customer data, documents, or agreements are still missing. Check `requiredActions`. - `PENDING`: All information is submitted and the customer is under review. - `ACTIONS_REQUIRED`: Additional information is requested during or after review. Check `requiredActions`. - `VERIFIED`: The customer is verified. - `REJECTED`: The customer failed verification. - `TERMINATED`: The customer was offboarded.
    - `type` 'COMPANY' | 'INDIVIDUAL'
    - `model` 'EMBEDDED' | 'RELIANCE': The onboarding model of the customer. `EMBEDDED` indicates BVNK-Managed onboarding, where BVNK performs identity verification. `RELIANCE` indicates Partner-Managed onboarding, where you perform identity verification.
    - `name` string
    - `createdAt` string, date-time
    - `authenticatedLink` V2AuthenticatedLinkResponse: Authenticated deep-link for the customer.
      - `link` string: Authenticated link URL.
      - `expiresAt` string, date-time: Link expiration timestamp.
  - `pageable` V2Pageable
    - `pageNumber` integer
    - `pageSize` integer
  - `hasNext` boolean

## Other responses

- `401`: Unauthorized

## Changes

- **2026-11-06** `c386d436bf2c`: 4 breaking, 4 warning, 8 info
  - removed the enum value `CUSTOMER_VIRTUAL_ACCOUNTS` from the property `items/` of the `query` request parameter `models`
  - removed the enum value `DOUBLE_EMBEDDED` from the property `items/` of the `query` request parameter `models`
  - removed the enum value `EMBEDDED_BVNK_MANAGED` from the property `items/` of the `query` request parameter `models`
  - removed the enum value `EMBEDDED_SELF_MANAGED` from the property `items/` of the `query` request parameter `models`
  - …12 more
- **2026-06-16** `97d6c0d2fe2e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/platform/v2/customers/get.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)