Skip to main content
PUT
TypeScript

Authorizations

Authorization
string
header
required

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

Path Parameters

auditId
string
required
controlId
string
required

Body

application/json

Input for upserting a control's auditor assessment within an audit. Overwrites the single assessment for this control in the audit's program segment.

assessmentState
enum<string>
required

The assessment state to record. Must be one of the states valid for the audit's framework; the request is rejected otherwise.

Available options:
IN_PLACE,
NOT_IN_PLACE,
PARTIAL,
NOT_ASSESSED,
CONFORMING,
MINOR_NON_CONFORMITY,
MAJOR_NON_CONFORMITY,
SATISFIED,
NOT_SATISFIED,
OTHER_THAN_SATISFIED,
TRUE,
FALSE
justification
string
required

Free-text reasoning for the assessment. Required, and at most 5000 characters.

auditorEmail
string
required

Email of the auditor performing the assessment. Must match an existing Vanta user who belongs to the audit firm making the API request.

Response

200 - application/json

Ok

A control's auditor assessment, as persisted. Returned by the assessment write endpoint so the caller sees exactly what was recorded.

controlId
string
required

The control this assessment belongs to.

assessmentState
enum<string>
required

The recorded assessment state.

Available options:
IN_PLACE,
NOT_IN_PLACE,
PARTIAL,
NOT_ASSESSED,
CONFORMING,
MINOR_NON_CONFORMITY,
MAJOR_NON_CONFORMITY,
SATISFIED,
NOT_SATISFIED,
OTHER_THAN_SATISFIED,
TRUE,
FALSE
justification
string
required

The recorded justification.