Documents
Get document by ID
Get a document by ID.
get/documents/{documentId}
Path parameters
documentIdstring required
Response
Ok
idstring required
The document's unique ID.
ownerIdstring nullable required
The user ID of the document's owner.
category'Accounts access' | 'Account security' | 'Account setup' | 'Computers' | 'Custom' | 'Data storage' | 'Employees' | 'Infrastructure' | 'IT' | 'Logging' | 'Monitoring alerts' | 'People' | 'Policies' | 'Risk analysis' | 'Software development' | 'CSPM alert management' | 'Vendors' | 'Vulnerability management' required
descriptionstring required
The document's description.
isSensitiveboolean required
Determines whether or not the document is sensitive.
titlestring required
The document's title.
uploadStatus'Needs document' | 'Needs update' | 'Not relevant' | 'OK' required
uploadStatusDatestring date-time nullable required
The date the document's uploadStatus changed.
urlstring nullable required
The URL to view the document within Vanta.
notestring nullable required
A user note for the document.
nextRenewalDatestring date-time nullable required
When the document needs to be renewed.
renewalCadence'P0D' | 'P1D' | 'P1W' | 'P1M' | 'P3M' | 'P6M' | 'P1Y' | 'P2Y' required
reminderWindow'P0D' | 'P1D' | 'P1W' | 'P1M' | 'P3M' required
subscribersstring[] required
A list of the emails subscribed to the document.