Create an auditor - Vanta Developer Hub

POST

auditors

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.auditors.create({
    email: "Genesis_Kunze87@yahoo.com",
    givenName: "<value>",
    familyName: "<value>",
  });

  console.log(result);
}

run();

{
  "id": "65fc81a3359c8508c9af880f",
  "organizationId": "8c9af880f1a335965fc850c8",
  "email": "testauditor@audit.com",
  "givenName": "Sam",
  "familyName": "Auditor"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

string

required

Email of the new user.

givenName

string

required

First name of the new user.

familyName

string

required

Last name of the new user.

Response

200 - application/json

string

required

organizationId

string

required

The unique identifier for the organization.

string

required

The email address of the auditor.

givenName

string

required

The given name (first name) of the auditor.

familyName

string

required

The family name (last name) of the auditor.

List auditsReturns a paginated list of audits scoped to the audit firm. To identify IRL (Information Request List) audits, check for the presence of the `auditorRequestListMetadata` field. This field is only present for IRL-based audits and will be `undefined` for standard audits.

⌘I

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.auditors.create({
    email: "Genesis_Kunze87@yahoo.com",
    givenName: "<value>",
    familyName: "<value>",
  });

  console.log(result);
}

run();

{
  "id": "65fc81a3359c8508c9af880f",
  "organizationId": "8c9af880f1a335965fc850c8",
  "email": "testauditor@audit.com",
  "givenName": "Sam",
  "familyName": "Auditor"
}

Documentation Index

Authorizations

Body

Response