Swipelux
Customer API

Get all customers

Retrieve all customers

GET
/v1/customers

Authorization

X-API-Key<token>

In: header

Response Body

The customers were retrieved successfully

responseRequiredarray<object>
export type Response = {
  /**
   * A unique identifier for the customer
   */
  id: string;
  /**
   * 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 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 KYC verification status of the customer
   */
  status: "not_started" | "incomplete" | "under_review" | "approved" | "rejected";
  /**
   * The provided metadata of the customer
   */
  metadata?: {
    [k: string]: string | number | boolean;
  } | null;
  /**
   * The creation date of the customer
   */
  createdAt: string;
  /**
   * The last update date of the customer
   */
  updatedAt: string;
}[];
 
curl -X GET "https://wallet.swipelux.com/v1/customers" \
  -H "X-API-Key: <token>"
[
  {
    "id": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phone": "string",
    "status": "not_started",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]