Skip to content

CustomerInfo ​

Type: schema

TypeScript Definition ​

typescript
CustomerInfo: {{
            /** @description user id */
            id?: $Read<string>;
            first_name?: string | null;
            last_name?: string | null;
            full_name?: $Read<string | null>;
            profile_image_url?: $Read<string | null>;
            country_code?: string;
            phone?: string | null;
            email?: string | null;
            is_phone_verified?: $Read<boolean>;
            is_email_verified?: $Read<boolean>;
            is_whatsapp_verified?: $Read<boolean>;
            /** @description `null` for customers with no status recorded. */
            status?: null | components["schemas"]["CustomerStatus"];
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
            /** @description Empty string when the customer has no recorded activity yet. */
            last_seen?: $Read<string | null>;
            kyc_status?: components["schemas"]["KycStatus"];
            is_verified?: $Read<boolean>;
            /** @description The Customer Group the customer belongs to. Drives group-specific pricing and promotions. */
            customer_group_id?: string | null;
            tags?: string[] | null;
        };
        /** CustomerListItem */
}

Component References ​

ReferenceResolves To
components["schemas"]["CustomerStatus"]CustomerStatus
components["schemas"]["KycStatus"]KycStatus

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "id": {
      "description": "user id",
      "type": "string",
      "readOnly": true
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "full_name": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "profile_image_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "country_code": {
      "type": "string"
    },
    "phone": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_phone_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_email_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_whatsapp_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "status": {
      "description": "`null` for customers with no status recorded.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/CustomerStatus"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "last_seen": {
      "description": "Empty string when the customer has no recorded activity yet.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "kyc_status": {
      "$ref": "#/components/schemas/KycStatus"
    },
    "is_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "customer_group_id": {
      "description": "The Customer Group the customer belongs to. Drives group-specific pricing and promotions.",
      "type": [
        "string",
        "null"
      ]
    },
    "tags": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    }
  },
  "title": "CustomerInfo",
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: