Run a compliance check

post

https://app.ekas.io/v1/checks

Runs the Ekas compliance engine over a subject given as stored-resource references or inline payloads (for each subject, pass the reference OR the inline payload — never both). Checks are free and unlimited and never consume allowance; with options.wait: true the connection is held until the verdict is ready, otherwise a fast check arrives already passed/changes_required and a slow one arrives processing for polling. options.include_website_review triggers a real crawl and is subject to a per-account daily quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Provide channel plus the subject — as stored-resource references (brand_id, campaign_id, rcs_agent_id, tfn_profile_id) or inline payloads (brand, campaign, rcs_agent, tfn_profile). For each subject, pass the reference OR the inline payload, never both.

channel

string

enum

required

Compliance channel.

Allowed:

brand_id

string

brand

object

Inline brand payload for checks and registrations. Partial payloads are welcome — the marketed minimum is ein + website — and anything missing or non-compliant surfaces as findings, not validation errors.

campaign_id

string

campaign

object

Inline campaign payload for checks and registrations. brand_id is omitted when paired with an inline brand. Partial payloads are welcome — missing or non-compliant fields surface as findings, not validation errors.

rcs_agent_id

string

rcs_agent

object

Inline RCS agent payload for checks and registrations. brand_id is omitted when paired with an inline brand; missing or non-compliant fields surface as findings.

tfn_profile_id

string

tfn_profile

object

Inline TFN profile payload for checks and registrations. brand_id is omitted when paired with an inline brand; missing or non-compliant fields surface as findings.

options

object

metadata

object

Free-form string map (≤50 keys, values ≤500 chars). Filterable on list endpoints.

Headers

Idempotency-Key

string

length ≤ 255

Any unique string (e.g. a UUID). Retries with the same key within 24h return the original response with Idempotent-Replayed: true. Same key + different body → 409.

Ekas-Subaccount

string

Scope this request (and the created resource) to a subaccount.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Check created. status is passed or changes_required when the check was fast or wait: true was set; processing otherwise — poll GET /checks/{id}.

400Invalid request (malformed body, missing/invalid parameter).

401Missing or invalid API key.

403API key lacks a required scope (named in error.param) or test-only endpoint called with a live key.

409Invalid state transition, in-flight registration conflict, or idempotency key reuse with a different body.

429Rate limit exceeded; see Retry-After. RateLimit-* headers appear on every response, not only 429s.