ConsistlyAPI
Checks

Retrieve a brand check

GET
/brand_checks/{id}

Authorization

ApiKey
AuthorizationBearer <token>

Bearer API key. Brand Governance endpoints require brand:read or brand:write (plus narrower writes for specific resources).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/brand_checks/brand_check_abc..."
{  "id": "string",  "object": "brand_check",  "status": "pending",  "content_type": "pptx",  "filename": "string",  "size_bytes": 0,  "findings": [    {      "id": "string",      "type": "string",      "severity": "low",      "title": "string",      "detail": "string",      "auto_fixable": true,      "slide_index": 0,      "shape_index": 0,      "paragraph_index": 0,      "page_number": 0,      "page_numbers": [        0      ],      "paragraph_indexes": [        0      ],      "source": "string",      "actual_color": "string",      "color_surface": "string",      "locations": [        "string"      ]    }  ],  "error_message": "string",  "livemode": true,  "metadata": {    "property1": "string",    "property2": "string"  },  "organization": "string",  "created_by": "string",  "created": "2019-08-24T14:15:22Z",  "completed": "2019-08-24T14:15:22Z"}
{  "error": {}}

Run a brand compliance check POST

Runs the organisation’s active brand rules against a deck (`pptx`) or document (`docx`) and returns the findings synchronously. The persisted record can be retrieved later via GET /brand_checks/{id} or referenced by the `brand.check.completed` event.

List brand-guideline extractions GET

Next Page