Update business customer | Swipelux Documentation

Partial Updates: All fields are optional - only provided fields will be updated. Omitted fields remain unchanged.

Overview

The PUT /v1/customers/business/{id} endpoint updates an existing business customer's information. This endpoint:

Accepts partial updates (only send fields you want to change)
Returns the complete updated business customer object
Validates that the customer exists and is a business type

HTTP Request

PUT /v1/customers/business/{id}

Path Parameters

Parameter	Type	Description
`id`	`string`	Required. The customer ID (starts with `cus_`)

Request Body

All fields are optional. Only include the fields you want to update.

Personal Information

Field	Type	Description
`firstName`	`string`	First name of the business representative
`middleName`	`string \| null`	Middle name of the business representative
`lastName`	`string`	Last name of the business representative
`birthDate`	`string`	Birth date (YYYY-MM-DD format)
`email`	`string`	Email address
`phone`	`string \| null`	Phone number

Identity Section

Field	Type	Description
`jurisdiction`	`string`	Country of jurisdiction (min 2 chars)
`entityType`	`string`	Type of business entity
`entityTypeDescription`	`string \| null`	Custom entity type description
`entityName`	`string`	Legal entity name
`tradeName`	`string \| null`	Business trade name / DBA
`registrationNumber`	`string \| null`	Business registration number
`incorporationDate`	`string \| null`	Date of incorporation (YYYY-MM-DD)
`taxNumber`	`string \| null`	Tax identification number

Details Section

Field	Type	Description
`businessDescription`	`string`	Description of business activities (min 10 chars)
`businessType`	`string`	Type or category of business
`businessTypeDescription`	`string \| null`	Custom business type description
`websites`	`string[] \| null`	Array of business website URLs
`phoneNumber`	`string \| null`	Business phone number

Address Section

Field	Type	Description
`addressCountry`	`string`	Country (min 2 chars)
`streetAddress`	`string`	Street address
`addressLine2`	`string \| null`	Additional address line
`city`	`string`	City
`state`	`string \| null`	State or province
`zip`	`string`	ZIP or postal code

Financial Information

Field	Type	Description
`sourceOfFunds`	`string`	Primary source of funds
`sourceOfFundDescription`	`string \| null`	Custom source description
`expectedMonthlyVolumeUsd`	`number`	Expected monthly volume in USD
`purposeOfFunds`	`string`	Purpose for using funds
`purposeOfFundsDescription`	`string \| null`	Custom purpose description
`flowOfFundsDescription`	`string`	How funds flow through business (min 10 chars)

Compliance

Field	Type	Description
`sanctionedCountryOperations`	`boolean`	Operates in sanctioned countries
`highRiskActivities`	`string[]`	Array of high-risk activities

Example Request

Response

Success Response (200 OK)

Returns the complete updated business customer object:

{
  "id": "cus_abc123xyz789",
  "firstName": "John",
  "lastName": "Smith",
  "birthDate": "1975-03-15",
  "email": "john@acmecorp.com",
  "phone": "+14155556789",
  "jurisdiction": "US",
  "entityType": "LLC",
  "entityName": "Acme Corporation Inc",
  "tradeName": "Acme Global",
  "registrationNumber": "LLC-2015-123456",
  "taxNumber": "98-7654321",
  "businessDescription": "Software development and consulting services",
  "businessType": "Technology",
  "websites": ["https://acmeglobal.com", "https://acmecorp.io"],
  "phoneNumber": "+14155550100",
  "addressCountry": "US",
  "streetAddress": "123 Market Street",
  "addressLine2": "Suite 500",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "sourceOfFunds": "Business Revenue",
  "expectedMonthlyVolumeUsd": 75000,
  "purposeOfFunds": "Business Operations",
  "flowOfFundsDescription": "Client payments via bank transfer for operations",
  "sanctionedCountryOperations": false,
  "highRiskActivities": [],
  "documents": [...],
  "shareholders": [...],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-20T14:45:00.000Z"
}

Error Responses

404 Not Found

Customer does not exist:

{
  "message": "Customer not found"
}

400 Bad Request

Customer exists but is not a business type:

{
  "message": "Customer is not a business type"
}

401 Unauthorized

Missing or invalid API key:

{
  "message": "Unauthorized"
}

422 Validation Error

Invalid field values:

{
  "message": "Validation error: businessDescription must be at least 10 characters"
}

Use Cases

Scenario	Example Fields to Update
Business name change	`entityName`, `tradeName`
Address update	`streetAddress`, `city`, `state`, `zip`
Volume increase	`expectedMonthlyVolumeUsd`
Website changes	`websites`
Contact update	`email`, `phone`, `phoneNumber`
Compliance update	`sanctionedCountryOperations`, `highRiskActivities`

Important Notes

This endpoint only updates basic business customer fields
To update documents or shareholders, use the dedicated document and shareholder endpoints
The id in the response is always the customer ID (cus_xxx)
All date fields should use ISO 8601 format (YYYY-MM-DD)

Create Business Customer - Create new business customer
Delete Business Customer - Delete business customer
Get Customer - Retrieve customer details