Skip to main content
POST
Create a one-off QC request

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner a request is scoped to is derived from the token; list endpoints also take an explicit owner query parameter your token must be authorized to read.

Body

application/json
owner
string
required

The ID of the owner

crid
string
required

A free-typed Creditor Reference ID identifying the matter this one-off request is for. There is no associated document.

checklistId
string<uuid>
required

The ID of the review-type QC checklist to copy items from. Must reference an active checklist with checklistType of review.

reviewee
string

User ID of the person being reviewed

notes
string

Notes about the request

Response

QC Request created successfully

id
string<uuid>
required

Unique identifier for the QC request

createdOn
string<date-time>
required

Timestamp when the QC request was created

status
enum<string>
required
Available options:
approved,
rejected,
pending
document
object
required
checklistItems
object[]
required
review
object
reviewCompletedOn
string<date-time>

Timestamp when the QC request had its review completed

reviewStartedOn
string<date-time>

Timestamp when the QC request had its review started

reviewedBy
string

User ID that reviewed the QC request

actors
object[]

Every actor (user) associated with this QC request across all roles, e.g. affiant, notary, reviewee.

fileUrl
string

A URL where the file can be downloaded from

Minimum string length: 1
processName
string

Display name of the associated QC process

checklistName
string

Display name of the associated QC checklist

checklistVersion
string

Version of the checklist that was active when the review was created, if any

notes
string

Notes about rework for the request