Organization

Get company profile

Returns the company profile of the organization selected by the authenticated token: the business details Vanta uses to tailor its compliance program, such as legal name, company size, operating regions, and the types of sensitive data the organization handles. Fields that haven’t been provided are null, and lists that haven’t been provided are empty. Requires vanta-api.all:read or vanta-api.all:write. No organization selector is accepted.

GET

organization

company-profile

Get company profile

curl --request GET \
  --url https://api.vanta.com/v1/organization/company-profile \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/organization/company-profile', 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/organization/company-profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vanta.com/v1/organization/company-profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/organization/company-profile")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "Example",
  "legalName": "Example, Inc.",
  "mailingAddress": "123 Main St, San Francisco, CA 94105",
  "telephone": "+1 415 555 0100",
  "websiteUrl": "https://example.com",
  "urls": [
    "https://app.example.com"
  ],
  "USCompany": true,
  "emailDomain": "example.com",
  "companySize": "51-100",
  "operatingRegions": [
    "north-america",
    "europe"
  ],
  "workplaceTypes": [
    "company-office",
    "home"
  ],
  "physicalDataCenters": false,
  "boardOfDirectors": true,
  "portableDevices": true,
  "externalSupport": false,
  "sensitiveDataTypes": [
    "pii"
  ]
}

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

The business details an organization provides so Vanta can tailor its compliance program. Fields that haven't been provided are null; lists that haven't been provided are empty.

displayName

string | null

required

The name the organization goes by.

legalName

string | null

required

The organization's registered legal name.

mailingAddress

string | null

required

telephone

string | null

required

websiteUrl

string | null

required

The organization's primary website.

urls

string[]

required

Websites associated with the organization; may include websiteUrl.

USCompany

boolean | null

required

Whether the organization is incorporated in the United States.

emailDomain

string | null

required

The organization's email domain.

companySize

string | null

required

Employee count range, such as 1-20 or 50001+.

operatingRegions

string[]

required

Regions the organization operates in, such as north-america or europe.

workplaceTypes

string[]

required

Employment model: company-office, coworking, or home.

physicalDataCenters

boolean | null

required

Whether the organization has physical data centers.

boardOfDirectors

boolean | null

required

Whether the organization has a board of directors.

portableDevices

boolean | null

required

Whether the organization uses portable devices.

externalSupport

boolean | null

required

Whether the organization provides external support.

sensitiveDataTypes

string[]

required

Types of sensitive data the organization handles: pii, phi, pci, or financial.

⌘I

Get company profile

curl --request GET \
  --url https://api.vanta.com/v1/organization/company-profile \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/organization/company-profile', 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/organization/company-profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vanta.com/v1/organization/company-profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/organization/company-profile")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "Example",
  "legalName": "Example, Inc.",
  "mailingAddress": "123 Main St, San Francisco, CA 94105",
  "telephone": "+1 415 555 0100",
  "websiteUrl": "https://example.com",
  "urls": [
    "https://app.example.com"
  ],
  "USCompany": true,
  "emailDomain": "example.com",
  "companySize": "51-100",
  "operatingRegions": [
    "north-america",
    "europe"
  ],
  "workplaceTypes": [
    "company-office",
    "home"
  ],
  "physicalDataCenters": false,
  "boardOfDirectors": true,
  "portableDevices": true,
  "externalSupport": false,
  "sensitiveDataTypes": [
    "pii"
  ]
}

API Basics

Manage API

Integrations API

Audit API

Webhooks

Get company profile

Authorizations

Response