Skip to main content
PUT
Verify an entity for a verification period

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

tagOrId
string
required

The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected. Entity identifier - can be a tag or CID

periodCid
string
required

The CID of the verification period

Body

application/json

An answer for one entity in one period

status
enum<string>
required

Whether the entity's data is correct. PENDING is not accepted.

Available options:
PENDING,
VERIFIED_CORRECT,
VERIFIED_INCORRECT
Example:

"VERIFIED_CORRECT"

reason
string

Why the entity is incorrect. Required when the period sets reasonRequired and the status is VERIFIED_INCORRECT.

Example:

"Ownership moved to the payments team"

Response

The recorded verification

An entity's status for one verification period

period
object
required

A time-boxed entity verification campaign

status
enum<string>
required

Whether the entity's data is correct. PENDING is not accepted.

Available options:
PENDING,
VERIFIED_CORRECT,
VERIFIED_INCORRECT
Example:

"VERIFIED_CORRECT"

reason
string

Why the entity was marked incorrect, when the verifier supplied one

Example:

"Ownership moved to the payments team"

verifiedAt
string<date-time>

When the entity was verified

verifiedByApiKey
object

An API key that verified an entity

verifiedByUser
object

The user who verified the entity. Null while the status is PENDING, and null when a global API key verified it.

Last modified on September 29, 2026