veeva · Schema

Veeva Vault Document

A document record in the Veeva Vault platform — a controlled document with lifecycle, version, and audit trail

Properties

Name	Type	Description
id	integer	Unique Vault document ID
name__v	string	Document name (required)
type__v	string	Document type API name (e.g., study_protocol__c)
subtype__v	string	Document subtype API name
classification__v	string	Document classification API name
lifecycle__v	string	Document lifecycle API name (controls allowed states and actions)
status__v	string	Current lifecycle state API name
document_number__v	string	Auto-generated document number
major_version_number__v	integer	Major version number (increments on approval)
minor_version_number__v	integer	Minor version number (increments on draft revisions)
created_by__v	integer	User ID of document creator
last_modified_by__v	integer	User ID of last modifier
created_date__v	string	Document creation timestamp
last_modified_date__v	string	Last modification timestamp
description__v	string	Document description
size__v	integer	Source file size in bytes
format__v	string	MIME type of source file (e.g., application/pdf)
external_id__v	string	External system identifier for integration
owner__v	integer	User ID of document owner
approver__v	integer	User ID of document approver
effective_date__v	stringnull	Date document becomes effective (approved state)
expiration_date__v	stringnull	Document expiration date

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.veevavault.com/schemas/document",
  "title": "Veeva Vault Document",
  "description": "A document record in the Veeva Vault platform — a controlled document with lifecycle, version, and audit trail",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique Vault document ID"
    },
    "name__v": {
      "type": "string",
      "description": "Document name (required)"
    },
    "type__v": {
      "type": "string",
      "description": "Document type API name (e.g., study_protocol__c)"
    },
    "subtype__v": {
      "type": "string",
      "description": "Document subtype API name"
    },
    "classification__v": {
      "type": "string",
      "description": "Document classification API name"
    },
    "lifecycle__v": {
      "type": "string",
      "description": "Document lifecycle API name (controls allowed states and actions)"
    },
    "status__v": {
      "type": "string",
      "description": "Current lifecycle state API name"
    },
    "document_number__v": {
      "type": "string",
      "description": "Auto-generated document number"
    },
    "major_version_number__v": {
      "type": "integer",
      "minimum": 0,
      "description": "Major version number (increments on approval)"
    },
    "minor_version_number__v": {
      "type": "integer",
      "minimum": 0,
      "description": "Minor version number (increments on draft revisions)"
    },
    "created_by__v": {
      "type": "integer",
      "description": "User ID of document creator"
    },
    "last_modified_by__v": {
      "type": "integer",
      "description": "User ID of last modifier"
    },
    "created_date__v": {
      "type": "string",
      "format": "date-time",
      "description": "Document creation timestamp"
    },
    "last_modified_date__v": {
      "type": "string",
      "format": "date-time",
      "description": "Last modification timestamp"
    },
    "description__v": {
      "type": "string",
      "description": "Document description"
    },
    "size__v": {
      "type": "integer",
      "minimum": 0,
      "description": "Source file size in bytes"
    },
    "format__v": {
      "type": "string",
      "description": "MIME type of source file (e.g., application/pdf)"
    },
    "external_id__v": {
      "type": "string",
      "description": "External system identifier for integration"
    },
    "owner__v": {
      "type": "integer",
      "description": "User ID of document owner"
    },
    "approver__v": {
      "type": "integer",
      "description": "User ID of document approver"
    },
    "effective_date__v": {
      "type": ["string", "null"],
      "format": "date",
      "description": "Date document becomes effective (approved state)"
    },
    "expiration_date__v": {
      "type": ["string", "null"],
      "format": "date",
      "description": "Document expiration date"
    }
  },
  "required": ["id", "name__v", "type__v", "lifecycle__v", "status__v"],
  "additionalProperties": {
    "description": "Custom field values (API names ending in __c)"
  }
}