COcortex
Verifications

Retrieve verifications

Changed on

Returns every verification in the workspace, one entry per entity and verification period, including entities that have not been verified yet. Each entry names the entity it belongs to, and who verified it once someone has.

get/api/v1/verifications

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/verifications
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

periodCidstring

Return only verifications belonging to this verification period

status'PENDING' | 'VERIFIED_CORRECT' | 'VERIFIED_INCORRECT'

Return only verifications in this state

isActiveboolean

Return only verifications whose period is open today (true) or only those whose period is not (false). Omit for all periods.

Response

A page of verifications

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "verifications": [
    {
      "entity": {
        "cid": "en0a1b2c3d4e5f6789",
        "name": "Payments API",
        "tag": "payments-api",
        "type": "service"
      },
      "period": {
        "cid": "vp0a1b2c3d4e5f6789",
        "isActive": true,
        "name": "Q3 Ownership Review"
      },
      "reason": "Ownership moved to the payments team",
      "status": "VERIFIED_CORRECT",
      "verifiedByApiKey": {
        "name": "ci-bot"
      }
    }
  ]
}

Changes