BVbvnk
Customers

Update customer

:::warning Before calling this endpoint, make sure you are not onboarding customers from restricted jurisdictions. For more information, see BVNK Acceptable Use Policy. :::

:::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. :::

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.

patch/platform/v1/customers/{customerReference}

Request

Path parameters

customerReferencestring uuid required
Example:0a184641-30e2-4414-871f-3db1c683900e

The unique identifier of the customer whose record will be updated. This must be a valid customer in the platform.

Request body

externalReferencestring

External reference for the customer. You can use it to store your own reference identifier for the customer.

Example request

{
  "externalReference": "1234567890",
  "individual": {
    "contactInfo": {
      "emailAddress": "walton.simmons@company.com",
      "phoneNumber": "+14155552671"
    },
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apartment 456",
      "postalCode": "NW1 4NP",
      "city": "London",
      "countryCode": "GB",
      "country": "Great Britain",
      "stateCode": "AL"
    },
    "dateOfBirth": "1985-08-15"
  }
}

Response

Successfully updated customer details

referencestring uuid required

Customer reference identifier

status'INIT' | 'PENDING' | 'APPROVED' | 'INFO_REQUIRED' required

Customer status

Example response

{
  "reference": "0a184641-30e2-4414-871f-3db1c683900e",
  "status": "APPROVED"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.