Checks
Run a brand compliance check
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.
Authorization
ApiKey AuthorizationBearer <token>
Bearer API key. Brand Governance endpoints require brand:read or brand:write (plus narrower writes for specific resources).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/brand_checks" \ -H "Content-Type: application/json" \ -d '{ "content_type": "pptx", "content_base64": "string" }'{ "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": {}}{ "error": {}}