BVbvnk
Customers

List customers

Changed on

:::info Customers API v2 The new customer onboarding flow is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward. :::

Retrieves the full list of Customers.

get/platform/v1/customers

Request

Query parameters

pagenumber

Page number (starts from 0)

sizenumber

Page size (max is 100)

namestring

Name of the customer to fetch

Response

successful operation

Example response

{
  "content": [
    {
      "reference": "0a184641-30e2-4414-871f-3db1c683900e",
      "status": "VERIFIED",
      "type": "COMPANY",
      "name": "UK Ltd Version 2.0",
      "description": "Number 1 customer, be super nice."
    }
  ],
  "page": {
    "size": 10,
    "totalElements": 10,
    "totalPages": 10
  }
}

Changes

  • c386d436bf2cRevision changes
    • warning

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