Docmost Octri Preview
POST/pages/create-verification

Set up verification on a page

Creates verification settings for a page and assigns one or more verifiers. Set type to expiring or qms; for expiring verification, choose mode to configure a period, fixed expiry date, or no expiry.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Page verification configuration, including the assigned verifiers and expiry settings.

fixedExpiresAtstringoptional
Required with `mode: fixed`. Must be a future date.
modestringoptional
Expiry mode: `period`, `fixed`, or `indefinite`.
Allowed:periodfixedindefinite
pageIdstringrequired
UUID of the page to configure verification for.
periodAmountintegeroptional
Required with `mode: period`, alongside `periodUnit`. The effective cap depends on `periodUnit` - 3650 days, 520 weeks, 120 months, or 20 years.
periodUnitstringoptional
Required with `mode: period`, alongside `periodAmount`.
Allowed:dayweekmonthyear
typestringoptional
Verification type: `expiring` or `qms`.
Allowed:expiringqms
verifierIdsarray<string>required
UUIDs of the assigned verifiers. Must contain between 1 and 5 items.

3 status codes
200Returns the created page verification settings in the response data.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when required fields are missing or verification settings fail validation, including invalid values or incompatible expiry fields.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when access is forbidden or an enterprise licence is required.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the request fails validation: pageId and verifierIds are required, and verifierIds must contain 1 to 5 UUIDs. type must be expiring or qms, and mode must be period, fixed, or indefinite; period mode requires periodAmount and periodUnit, while fixed mode requires a future fixedExpiresAt. A 403 is returned when access is forbidden or an enterprise licence is required.