VTEX · Schema

ClientProfile

Client profile information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
email string Customer's email address.
firstName string Customer's first name.
lastName string Customer's last name.
document string Document number informed by the customer.
phone string Customer's phone number.
birthDate string Customer's birth date.
isCorporate boolean Defines if the customer is a company (`true`) or not (`false`).
View JSON Schema on GitHub

JSON Schema

vtex-clientprofile-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientProfile",
  "title": "ClientProfile",
  "type": "object",
  "description": "Client profile information.",
  "required": [
    "email",
    "firstName",
    "lastName",
    "document",
    "phone",
    "birthDate",
    "isCorporate"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Customer's email address.",
      "example": "[email protected]"
    },
    "firstName": {
      "type": "string",
      "description": "Customer's first name.",
      "example": "Michael"
    },
    "lastName": {
      "type": "string",
      "description": "Customer's last name.",
      "example": "Scott"
    },
    "document": {
      "type": "string",
      "description": "Document number informed by the customer.",
      "example": "02906792063"
    },
    "phone": {
      "type": "string",
      "description": "Customer's phone number.",
      "example": "+551111111111"
    },
    "birthDate": {
      "type": "string",
      "description": "Customer's birth date.",
      "example": "0001-01-01T00:00:00"
    },
    "isCorporate": {
      "type": "boolean",
      "description": "Defines if the customer is a company (`true`) or not (`false`).",
      "example": false
    }
  }
}