Get framework codes for an audit

Retrieves all valid framework codes for the specified audit. This endpoint helps users discover which framework codes are available for creating and updating information requests for this audit.

Use this endpoint to:

• Discover available framework codes before creating information requests
• Validate framework codes against the audit’s framework
• Get context about what framework codes are available for the audit type

GET /audits/{auditId}/framework-codes

TypeScript

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.audits.getFrameworkCodes({
    auditId: "<id>",
  });

  console.log(result);
}

run();

200

{
  "frameworkCodes": [
    "CC1.1",
    "CC1.2",
    "CC1.3",
    "CC2.1",
    "CC2.2",
    "CC3.1",
    "CC3.2",
    "CC4.1",
    "CC4.2",
    "CC5.1",
    "CC5.2",
    "CC6.1",
    "CC6.2",
    "CC7.1",
    "CC7.2",
    "CC8.1",
    "CC8.2"
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

auditId · string · required

Response

200 - application/json

Ok

Framework codes response resource

frameworkCodes · string[] · required

Array of valid framework codes for the audit's framework (e.g., "CC6.1", "CC6.2"). These represent the different framework sections available for creating information requests.