Skip to main content
POST
Create an organization filing check

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Body

application/json
name
string
required

Human-readable check name, 1–200 characters after trimming surrounding whitespace. Fixed on creation; names need not be unique.

Required string length: 1 - 200
markdown
string
required

Nonblank Markdown instructions describing applicability, evidence, and findings. Maximum 64 KiB (65,536 UTF-8 bytes).

Required string length: 1 - 65536

Response

Published organization check.

id
string<uuid>
required
name
string
required

Human-readable check name, fixed when created.

scope
enum<string>
required

Global checks are shared by Effective; organization checks belong to your tenant.

Available options:
global,
organization
versionId
string<uuid>
required

Immutable instruction revision. Retain this ID with review results.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required

When the check was last published; historical reads retain this catalog timestamp.

markdown
string
required

Markdown instructions, applicability guidance, examples, and sources.