Create verification

post/addverificationreminder

Creates a verification reminder for the document. Users can create verification reminders from different product surfaces.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Details about the reminder.

documentId
required
string

The document which the verification is for new reminders and/or update.

assignee
string

The obfuscated id of the person this verification is assigned to.

reason
string

An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect").

remindInDays
integer

Reminder for the next verifications in terms of days. For deletion, this will be omitted.

Responses
200

OK

Response Schema: application/json
state
required
string

The verification state for the document.

Enum: "UNVERIFIED" "VERIFIED" "DEPRECATED"
object (VerificationMetadata)
400

Invalid request

401

Not Authorized

403

Document does not exist, does not support verification or user cannot access document

429

Too Many Requests

Request samples
application/json
{
  • "documentId": "string",
  • "assignee": "string",
  • "remindInDays": 0,
  • "reason": "string"
}
Response samples
application/json
{
  • "state": "UNVERIFIED",
  • "metadata": {
    • "lastVerifier": {
      • "name": "George Clooney",
      • "obfuscatedId": "abc123"
      },
    • "lastVerificationTs": 0,
    • "expirationTs": 0,
    • "document": {
      • "id": "string",
      • "datasource": "string",
      • "connectorType": "API_CRAWL",
      • "docType": "string",
      • "content": {
        • "fullTextList": [
          • "string"
          ]
        },
      • "containerDocument": { },
      • "parentDocument": { },
      • "title": "string",
      • "url": "string",
      • "metadata": {
        • "container": "container",
        • "parentId": "JIRA_EN-1337",
        • "createTime": "2000-01-23T04:56:07.000Z",
        • "datasource": "datasource",
        • "author": {
          • "name": "name"
          },
        • "documentId": "documentId",
        • "updateTime": "2000-01-23T04:56:07.000Z",
        • "mimeType": "mimeType",
        • "objectType": "Feature Request",
        • "components": [
          • "Backend",
          • "Networking"
          ],
        • "status": [
          • "Done"
          ],
        • "customData": {
          • "someCustomField": "someCustomValue"
          }
        },
      • "sections": [
        • {
          • "title": "string",
          • "url": "string"
          }
        ]
      },
    • "reminders": [
      • {
        • "assignee": {
          • "name": "George Clooney",
          • "obfuscatedId": "abc123"
          },
        • "requestor": {
          • "name": "George Clooney",
          • "obfuscatedId": "abc123"
          },
        • "remindAt": 0,
        • "createdAt": 0,
        • "reason": "string"
        }
      ],
    • "lastReminder": {
      • "assignee": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "requestor": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "remindAt": 0,
      • "createdAt": 0,
      • "reason": "string"
      },
    • "visitorCount": [
      • {
        • "count": 0,
        • "period": {
          • "minDaysFromNow": 0,
          • "maxDaysFromNow": 0,
          • "start": {
            • "epochSeconds": 0,
            • "daysFromNow": 0
            },
          • "end": {
            • "epochSeconds": 0,
            • "daysFromNow": 0
            }
          },
        • "org": "string"
        }
      ],
    • "candidateVerifiers": [
      • {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        }
      ]
    }
}