Skip to main content
GET
Read a filing check

Authorizations

Authorization
string
header
required

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

Path Parameters

checkId
string<uuid>
required

Query Parameters

versionId
string<uuid>

Read an immutable previous revision. Omit for the current published revision.

Response

Check instructions and revision.

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.