Complete questionnaire

Complete a questionnaire and optionally sync approved answers to the answer library.

Transitions the questionnaire status to COMPLETE. If shouldSyncApprovedToAnswerLibrary is true (the default), approved answers are added to the answer library for future use. For non-English SPREADSHEET or DOCUMENT questionnaires, answer library sync will be ignored.

POST /customer-trust/questionnaires/{questionnaireId}/complete

Complete questionnaire

cURL

curl --request POST \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/{questionnaireId}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shouldSyncApprovedToAnswerLibrary": true
}
'

200

{
  "id": "507f1f77bcf86cd799439011",
  "displayName": "SOC 2 Security Questionnaire",
  "type": "SPREADSHEET",
  "status": "IN_PROGRESS",
  "statusLog": [],
  "dueDate": "2024-12-31T00:00:00.000Z",
  "metadata": [
    {
      "key": "priority",
      "value": "high"
    }
  ],
  "tagAndCategoryIds": [],
  "createdDate": "2024-12-01T00:00:00.000Z",
  "updatedDate": "2024-12-14T00:00:00.000Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

questionnaireId · string · required

Body

application/json

Request body for completing a questionnaire.

shouldSyncApprovedToAnswerLibrary · boolean

Whether to sync approved answers to the answer library. Defaults to true. Ignored for non-English SPREADSHEET/DOCUMENT questionnaires.

Response

200 - application/json

Ok

id · string · required

displayName · string · required

type · enum<string> · required

Available options: SPREADSHEET, WEBSITE, DOCUMENT

status · enum<string> · required

Available options: APPROVED, IN_PROGRESS, IN_REVIEW, READY_FOR_REVIEW, WAITING_ON_ANSWERS, ON_HOLD, NO_LONGER_NEEDED, COMPLETE, ERROR, EXTRACTING_QUESTIONS, QUEUED_FOR_EXTRACTION, PROCESSING, QUEUED_FOR_PROCESSING, WAITING_ON_COLUMN_SELECTION, WAITING_ON_COLUMN_APPROVAL, QUEUED_FOR_COLUMN_DETECTION, DETECTING_COLUMNS

statusLog · object[] · required

The status change history log for the questionnaire. Entries are ordered by the most recent status change first.

Show child attributes

tagAndCategoryIds · object[] · required

Tags assigned to this questionnaire. Each entry contains a categoryId and tagId.

Show child attributes

createdDate · string<date-time> · required

updatedDate · string<date-time> · required

url · string

ownerAssignment · object

The owner assignment in actor form (User or Team).

Show child attributes

approverAssignment · object

The approver assignment in actor form (User or Team).

Show child attributes

customerTrustAccountId · string

dueDate · string<date-time>

metadata · object[]

Show child attributes

completedDate · string<date-time>