> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vanta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a custom evidence request for an audit

> Create a custom evidence request for an audit.

Rate limit: 10 requests / minute.



## OpenAPI

````yaml https://spec.speakeasy.com/vanta/vanta/conduct-an-audit-with-code-samples post /audits/{auditId}/evidence/custom-evidence-requests
openapi: 3.0.0
info:
  title: Conduct an audit
  version: 1.0.0
  description: >-
    The Auditor API lets audit firms conduct audits from a tool outside of
    Vanta. Unlock data syncing with Vanta through this API.


    **Note for Vanta Gov (FedRAMP) customers:** Select `Vanta Gov (FedRAMP)`
    from the server dropdown to issue requests against
    `https://api.vanta-gov.com`. The OAuth token URL shown below defaults to the
    commercial host — replace it with `https://api.vanta-gov.com/oauth/token`.
  termsOfService: https://www.vanta.com/terms
  license:
    name: UNLICENSED
  contact:
    name: API Support
    url: https://help.vanta.com/
    email: support@vanta.com
servers:
  - url: https://api.vanta.com/v1
    description: Vanta (Commercial)
  - url: https://api.vanta-gov.com/v1
    description: Vanta Gov (FedRAMP)
security: []
paths:
  /audits/{auditId}/evidence/custom-evidence-requests:
    post:
      tags:
        - Audits
      summary: Create a custom evidence request for an audit
      description: |-
        Create a custom evidence request for an audit.

        Rate limit: 10 requests / minute.
      operationId: CreateCustomEvidenceRequest
      parameters:
        - in: path
          name: auditId
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomEvidenceRequestInput'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEvidenceRequest'
              examples:
                Example 1:
                  value:
                    id: 65fc81a3359c8508c9af880f
                    controlIds:
                      - 1.1.2.a
                    title: Access Control Policy
                    description: Description for Access Control Policy
                    cadence: P6M
                    reminderWindow: P6M
                    isRestricted: true
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: CreateCustomEvidenceRequest
          source: |-
            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.createCustomEvidenceRequest({
                auditId: "<id>",
                createCustomEvidenceRequestInput: {
                  controlIds: [
                    "<value 1>",
                    "<value 2>",
                  ],
                  title: "<value>",
                  description: "pure bludgeon deliberately question although",
                  cadence: "P1D",
                  reminderWindow: "P0D",
                  isRestricted: false,
                  auditorEmail: "<value>",
                },
              });

              console.log(result);
            }

            run();
        - lang: java
          label: CreateCustomEvidenceRequest
          source: >-
            package hello.world;


            import com.vanta.vanta_auditor_api.Vanta;

            import
            com.vanta.vanta_auditor_api.models.components.CreateCustomEvidenceRequestInput;

            import
            com.vanta.vanta_auditor_api.models.components.RecurrenceDuration;

            import
            com.vanta.vanta_auditor_api.models.operations.CreateCustomEvidenceRequestResponse;

            import java.lang.Exception;

            import java.util.List;


            public class Application {

                public static void main(String[] args) throws Exception {

                    Vanta sdk = Vanta.builder()
                            .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
                        .build();

                    CreateCustomEvidenceRequestResponse res = sdk.audits().createCustomEvidenceRequest()
                            .auditId("<id>")
                            .createCustomEvidenceRequestInput(CreateCustomEvidenceRequestInput.builder()
                                .controlIds(List.of(
                                    "<value 1>",
                                    "<value 2>"))
                                .title("<value>")
                                .description("pure bludgeon deliberately question although")
                                .cadence(RecurrenceDuration.P1_D)
                                .reminderWindow(RecurrenceDuration.P0_D)
                                .isRestricted(false)
                                .auditorEmail("<value>")
                                .build())
                            .call();

                    if (res.customEvidenceRequest().isPresent()) {
                        System.out.println(res.customEvidenceRequest().get());
                    }
                }
            }
components:
  schemas:
    CreateCustomEvidenceRequestInput:
      properties:
        controlIds:
          items:
            type: string
          type: array
          description: A set of controls, referenced by id, to map the evidence to
        title:
          type: string
          description: Title for the evidence request
        description:
          type: string
          description: Description for the evidence request
        cadence:
          $ref: '#/components/schemas/RecurrenceDuration'
          description: Renewal cadence
        reminderWindow:
          $ref: '#/components/schemas/RecurrenceDuration'
          description: >-
            Duration representing when to send notifications, relative to
            renewal date
        isRestricted:
          type: boolean
          description: >-
            Whether this document contains sensitive data and needs more
            restrictive read access
        auditorEmail:
          type: string
          description: Email of the auditor who created the custom evidence request.
      required:
        - controlIds
        - title
        - description
        - cadence
        - reminderWindow
        - isRestricted
        - auditorEmail
      type: object
      additionalProperties: false
    CustomEvidenceRequest:
      properties:
        id:
          type: string
          description: Internal id of the custom evidence request within Vanta
        controlIds:
          items:
            type: string
          type: array
          description: A set of controls, referenced by id, to map the evidence to
        title:
          type: string
          description: Title for the evidence request
        description:
          type: string
          description: Description for the evidence request
        cadence:
          $ref: '#/components/schemas/RecurrenceDuration'
          description: Renewal cadence
        reminderWindow:
          $ref: '#/components/schemas/RecurrenceDuration'
          description: >-
            Duration representing when to send notifications, relative to
            renewal date
        isRestricted:
          type: boolean
          description: >-
            Whether this document contains sensitive data and needs more
            restrictive read access
      required:
        - id
        - controlIds
        - title
        - description
        - cadence
        - reminderWindow
        - isRestricted
      type: object
      additionalProperties: false
    RecurrenceDuration:
      enum:
        - P0D
        - P1D
        - P1W
        - P1M
        - P3M
        - P6M
        - P1Y
        - P2Y
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````