VTEX · Schema

Profile

Profile schema.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
firstName	string	Client's first name.
lastName	string	Client's last name.
email	string	Client's email address.
birthDate	string	Client's birth date in ISO 8601 format.
document	string	Client's document.
documentType	string	Type of document informed in `document`.
{customField}	string	Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Profile",
  "title": "Profile",
  "type": "object",
  "description": "Profile schema.",
  "required": [
    "firstName",
    "lastName",
    "email",
    "document",
    "documentType"
  ],
  "properties": {
    "firstName": {
      "type": "string",
      "description": "Client's first name.",
      "example": "John"
    },
    "lastName": {
      "type": "string",
      "description": "Client's last name.",
      "example": "Doe"
    },
    "email": {
      "type": "string",
      "description": "Client's email address.",
      "example": "[email protected]"
    },
    "birthDate": {
      "type": "string",
      "description": "Client's birth date in ISO 8601 format.",
      "example": "1925-11-17"
    },
    "document": {
      "type": "string",
      "description": "Client's document.",
      "example": "12345678900"
    },
    "documentType": {
      "type": "string",
      "description": "Type of document informed in `document`.",
      "example": "CPF"
    },
    "{customField}": {
      "type": "string",
      "description": "Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object.",
      "example": "{value}"
    }
  }
}