Create a custom document

post

https://api.vanta.com/v1/documents

Create a custom document.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

The document's title.

description

string

required

The document's description.

timeSensitivity

string

enum

required

When to upload the document. Must be one of: "Most recent", "During audit window"

Allowed:

cadence

string

enum

required

How often the document needs to be renewed.

Never: P0D - The document does not need to be renewed. Daily: P1D - The document needs to be renewed daily. Weekly: P1W - The document needs to be renewed weekly. Monthly: P1M - The document needs to be renewed monthly. Quarterly: P3M - The document needs to be renewed quarterly. Biannually: P6M - The document needs to be renewed biannually. Annually: P1Y - The document needs to be renewed annually.

reminderWindow

string

enum

required

The number of days before the renewal date to send a reminder. Note that reminderWindow should be smaller than the cadence.

Options are: Never: P0D - No reminder will be sent. Day: P1D - A reminder will be sent one day before the renewal date. Week: P1W - A reminder will be sent one week before the renewal date. Month: P1M - A reminder will be sent one month before the renewal date. Quarter: P3M - A reminder will be sent one quarter before the renewal date.

Allowed:

isSensitive

boolean

required

Determines whether or not the document is sensitive. This restricts which users can access or upload files to the document. Only admins are able to view or upload sensitive documents.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Document created