---
title: "Update customer"
method: PATCH
path: "/platform/v1/customers/{customerReference}"
tags: ["Customers"]
---

# Update customer

`PATCH /platform/v1/customers/{customerReference}`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers/{customerReference}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/:customerReference/patch.ts> (a function with typed inputs; its response is checked against the schema)

:::warning
Before calling this endpoint, make sure you are not onboarding customers from restricted jurisdictions. For more information, see [BVNK Acceptable Use Policy](https://help.bvnk.com/hc/en-us/articles/11100445499666-BVNK-Acceptable-Use-Policy-Financial-Crime).
:::

:::info Customers API v2
The [new customer onboarding flow](../../../get-started/create-embedded-partner-customer/create-customers-com) 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.
:::

Updates customer information for individual customers. You can update contact information (email and phone), address details, and date of birth.

Only include the fields in your request that you want to update.

## Path parameters

- `customerReference` string, uuid, required

## Request body

- object: Any subset of updatable fields may be provided.
  - `externalReference` string: External reference for the customer. You can use it to store your own reference identifier for the customer.
  - `individual` object: Individual customer information to update.
    - `contactInfo` object: Contact information for the customer.
      - `emailAddress` string, email: Email address.
      - `phoneNumber` string: Phone number in the E.164 format.
    - `address` AddressV2
      - `addressLine1` string, required: Main address
      - `addressLine2` string: Apartment numbers or suite number
      - `postalCode` string, required: Postal code
      - `city` string, required: City
      - `countryCode` string, required: 2-letter country code in the ISO 3166-1 alpha-2 format.
      - `country` string: Country of residence
      - `stateCode` string: 2-letter state code. **Required for US customers**.
    - `dateOfBirth` string, date: Date of birth in the YYYY-MM-DD format. You can only update this field when the customer is in `INFO_REQUIRED` state.

## Response `200`

Successfully updated customer details

- object
  - `reference` string, uuid, required: Customer reference identifier
  - `status` 'INIT' | 'PENDING' | 'APPROVED' | 'INFO_REQUIRED', required: Customer status

## Other responses

- `400`: Bad request - validation failed or invalid data provided
- `401`: Unauthorized - invalid or missing API credentials
- `404`: The specified resource was not found

---

[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)