Skip to content

CustomerInfo

Type: schema

TypeScript Definition

typescript
CustomerInfo: {{
            /** @description user id */
            readonly id?: string;
            first_name?: string;
            last_name?: string;
            readonly full_name?: string;
            readonly profile_image_url?: string;
            country_code?: string;
            phone?: string;
            email?: string;
            readonly is_phone_verified?: boolean;
            readonly is_email_verified?: boolean;
            readonly is_whatsapp_verified?: boolean;
            /** @enum {unknown} */
            status?: "active" | "inactive" | "suspended" | "blocked";
            /** Format: date-time */
            readonly created_at?: string;
            /** Format: date-time */
            readonly modified_at?: string;
            /** Format: date-time */
            readonly last_seen?: string;
            readonly kyc_status?: boolean;
            readonly is_verified?: boolean;
            tags?: string[];
        };
        /** CustomerLoyalty */
}

OpenAPI Schema

json
{
  "type": "object",
  "properties": {
    "id": {
      "description": "user id",
      "type": "string",
      "readOnly": true
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "full_name": {
      "type": "string",
      "readOnly": true
    },
    "profile_image_url": {
      "type": "string",
      "readOnly": true
    },
    "country_code": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "is_phone_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_email_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_whatsapp_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "suspended",
        "blocked"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "last_seen": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "kyc_status": {
      "type": "boolean",
      "readOnly": true
    },
    "is_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "title": "CustomerInfo",
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: