BVbvnk
Customers

Search customers

Changed on

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

get/platform/v2/customers

Request

Query parameters

namestring
Example:Krause

Filter by customer display name (partial match).

statusesstring[]

Filter by lifecycle status. Repeat to pass multiple values.

typesstring[]

Filter by customer type.

modelsstring[]

Filter by onboarding model: EMBEDDED (BVNK-Managed) or RELIANCE (Partner-Managed).

useCasesstring[]

Filter by one or more use cases. Repeat to pass multiple values.

referencestring

Filter by partner-supplied reference (exact match).

pageNumberinteger

Zero-based page number.

pageSizeinteger
Example:20

Number of items per page. Max 500.

Response

Paginated list of customers

totalElementsinteger
totalPagesinteger
hasNextboolean

Example response

{
  "content": [
    {
      "status": "PENDING"
    }
  ]
}

Changes

  • c386d436bf2cRevision changes
    • breaking

      removed the enum value CUSTOMER_VIRTUAL_ACCOUNTS from the property items/ of the query request parameter models

    • breaking

      removed the enum value DOUBLE_EMBEDDED from the property items/ of the query request parameter models

    • breaking

      removed the enum value EMBEDDED_BVNK_MANAGED from the property items/ of the query request parameter models

    • breaking

      removed the enum value EMBEDDED_SELF_MANAGED from the property items/ of the query request parameter models

    • warning

      for the query request parameter reference, the maxLength was set to 36

    • warning

      added the new AGREEMENTS_PENDING enum value to the // response property for the response status

    • warning

      added the new EMBEDDED enum value to the // response property for the response status

    • warning

      added the new RELIANCE enum value to the // response property for the response status

    • info

      added the new optional query request parameter useCases

    • info

      added the enum value AGREEMENTS_PENDING to the property items/ of the query request parameter statuses

    • info

      added the enum value EMBEDDED to the property items/ of the query request parameter models

    • info

      added the enum value RELIANCE to the property items/ of the query request parameter models

    • info

      removed the CUSTOMER_VIRTUAL_ACCOUNTS enum value from the // response property for the response status

    • info

      removed the DOUBLE_EMBEDDED enum value from the // response property for the response status

    • info

      removed the EMBEDDED_BVNK_MANAGED enum value from the // response property for the response status

    • info

      removed the EMBEDDED_SELF_MANAGED enum value from the // response property for the response status

  • 97d6c0d2fe2eRevision changes
    • info

      endpoint added