Swipelux

Delete a customer

Delete a customer

HTTP request

DELETE /v1/customers/{id}

Path parameters

ParameterTypeDescription
idstringRequired. The customer ID to delete

Example response

{
  "success": true,
  "message": "Customer successfully deleted"
}

Code examples


DELETE
/v1/customers/{id}

Authorization

X-API-Key<token>

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

In: header

Path Parameters

idRequiredstring

The customer ID

Response Body

The customer has been deleted successfully

idRequiredstring

A unique identifier for the customer

typeRequiredunknown

The type of customer: individual or business

Value in: "individual" | "business"
firstNamestring | null

The first name of the customer

middleNamestring | null

The middle name of the customer

lastNamestring | null

The last name of the customer

legalNamestring | null

The legal name of the business (for business customers)

websitestring | null

The website URL of the business (for business customers)

emailRequiredstring

The primary email address of the customer

Format: "email"
phoneRequiredstring

The primary phone number of the customer in E.164 format (e.g., +1234567890)

Minimum length: 1Maximum length: 32
birthDatestring | null

The date of birth of the customer in ISO 8601 format (YYYY-MM-DD)

countrystring | null

The country of the customer (ISO 3166-1 alpha-2 or alpha-3 code)

statusRequiredunknown

The KYC verification status of the customer

Value in: "not_started" | "incomplete" | "under_review" | "approved" | "rejected" | "pending_verification"
metadataobject | null

The provided metadata of the customer

walletAddressesarray<string>

Array of customer wallet addresses (only present in legacy mode)

balanceRequirednumber

The total balance of the customer in USD

createdAtRequiredstring

The date and time the customer was created

updatedAtRequiredstring

The date and time the customer was last updated

export interface Response {
  /**
   * A unique identifier for the customer
   */
  id: string;
  /**
   * The type of customer: individual or business
   */
  type: "individual" | "business";
  /**
   * The first name of the customer
   */
  firstName?: string | null;
  /**
   * The middle name of the customer
   */
  middleName?: string | null;
  /**
   * The last name of the customer
   */
  lastName?: string | null;
  /**
   * The legal name of the business (for business customers)
   */
  legalName?: string | null;
  /**
   * The website URL of the business (for business customers)
   */
  website?: string | null;
  /**
   * The primary email address of the customer
   */
  email: string;
  /**
   * The primary phone number of the customer in E.164 format (e.g., +1234567890)
   */
  phone: string;
  /**
   * The date of birth of the customer in ISO 8601 format (YYYY-MM-DD)
   */
  birthDate?: string | null;
  /**
   * The country of the customer (ISO 3166-1 alpha-2 or alpha-3 code)
   */
  country?: string | null;
  /**
   * The KYC verification status of the customer
   */
  status: "not_started" | "incomplete" | "under_review" | "approved" | "rejected" | "pending_verification";
  /**
   * The provided metadata of the customer
   */
  metadata?: {
    [k: string]: string | number | boolean;
  } | null;
  /**
   * Array of customer wallet addresses (only present in legacy mode)
   */
  walletAddresses?: string[];
  /**
   * The total balance of the customer in USD
   */
  balance: number;
  /**
   * The date and time the customer was created
   */
  createdAt: string;
  /**
   * The date and time the customer was last updated
   */
  updatedAt: string;
}
 
curl -X DELETE "https://wallet.swipelux.com/v1/customers/string" \
  -H "X-API-Key: <token>"
{
  "id": "string",
  "type": "individual",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "legalName": "string",
  "website": "string",
  "email": "user@example.com",
  "phone": "string",
  "birthDate": "2019-08-24",
  "country": "str",
  "status": "not_started",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "walletAddresses": [
    "string"
  ],
  "balance": 0,
  "createdAt": "string",
  "updatedAt": "string"
}