Profile

{
  "$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": "john.doe@example.com"
    },
    "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}"
    }
  }
}