Verify an entity for a verification period
Records the caller’s answer for one entity in one verification period. The period must be open, and the caller must own the entity — unless it is a global API key granted the “Verify any entity” permission, for which ownership is waived.
Authorizations
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
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
The CID of the verification period
Body
An answer for one entity in one period
Whether the entity's data is correct. PENDING is not accepted.
PENDING, VERIFIED_CORRECT, VERIFIED_INCORRECT "VERIFIED_CORRECT"
Why the entity is incorrect. Required when the period sets reasonRequired and the status is VERIFIED_INCORRECT.
"Ownership moved to the payments team"
Response
The recorded verification
An entity's status for one verification period
A time-boxed entity verification campaign
Whether the entity's data is correct. PENDING is not accepted.
PENDING, VERIFIED_CORRECT, VERIFIED_INCORRECT "VERIFIED_CORRECT"
Why the entity was marked incorrect, when the verifier supplied one
"Ownership moved to the payments team"
When the entity was verified
An API key that verified an entity
The user who verified the entity. Null while the status is PENDING, and null when a global API key verified it.