Create a custom document - Vanta Developer Hub

POST

/

documents

Create a custom document

curl --request POST \
  --url https://api.vanta.com/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "isSensitive": true
}
'

import requests

url = "https://api.vanta.com/v1/documents"

payload = {
    "title": "<string>",
    "description": "<string>",
    "isSensitive": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: '<string>', description: '<string>', isSensitive: true})
};

fetch('https://api.vanta.com/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'isSensitive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vanta.com/v1/documents"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vanta.com/v1/documents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "1",
  "ownerId": "2",
  "category": "Account setup",
  "description": "Provide two examples of a recent access request and approval ",
  "isSensitive": false,
  "title": "Document Title",
  "uploadStatus": "Needs document",
  "uploadStatusDate": "2024-03-17T00:00:00.000Z",
  "url": "https://example.com"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

title

string

required

The document's title.

description

string

required

The document's description.

timeSensitivity

enum<string>

required

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

Available options:

MOST_RECENT,

DURING_AUDIT_WINDOW

cadence

enum<string>

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.

Available options:

P0D,

P1D,

P1W,

P1M,

P3M,

P6M,

P1Y,

P2Y

reminderWindow

enum<string>

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.

Available options:

P0D,

P1D,

P1W,

P1M,

P3M

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

201 - application/json

Document created

id

string

required

The document's unique ID.

ownerId

string | null

required

The user ID of the document's owner.

category

enum<string>

required

The document's category.

Available options:

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

description

string

required

The document's description.

isSensitive

boolean

required

Determines whether or not the document is sensitive.

title

string

required

The document's title.

uploadStatus

enum<string>

required

The document's status.

Available options:

Needs document,

Needs update,

Not relevant,

OK

uploadStatusDate

string<date-time> | null

required

The date the document's uploadStatus changed.

url

string | null

required

The URL to view the document within Vanta.

⌘I

Create a custom document

curl --request POST \
  --url https://api.vanta.com/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "isSensitive": true
}
'

import requests

url = "https://api.vanta.com/v1/documents"

payload = {
    "title": "<string>",
    "description": "<string>",
    "isSensitive": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: '<string>', description: '<string>', isSensitive: true})
};

fetch('https://api.vanta.com/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'isSensitive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vanta.com/v1/documents"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vanta.com/v1/documents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isSensitive\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "1",
  "ownerId": "2",
  "category": "Account setup",
  "description": "Provide two examples of a recent access request and approval ",
  "isSensitive": false,
  "title": "Document Title",
  "uploadStatus": "Needs document",
  "uploadStatusDate": "2024-03-17T00:00:00.000Z",
  "url": "https://example.com"
}