Create a registration

post

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

Create the billable submission for a brand, campaign, RCS agent, or toll-free verification. A compliance check always runs first — blocking findings halt the registration at changes_required and nothing reaches a provider. Delivery is provider (Ekas submits through your connected account), package (retrieve the compliant payload and submit yourself), or push (Ekas POSTs the signed package to your URL); alternatively pass import to adopt an already-registered asset, created directly as approved with imported: true and no allowance consumed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Provide type, the subject (reference or inline payload — inline payloads are materialized into stored resources), delivery, and (for provider mode) a connection. Or provide import to adopt an already-registered asset. A compliance check always runs first; blocking findings halt the registration at changes_required before anything reaches a provider. Inline payloads must be structurally complete for the registration type (server-validated with a 400 naming the missing field); pair an inline subject with an inline brand instead of a brand_id when the brand is not stored yet.

type

string

enum

required

What is being registered.

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.

provider_connection_id

string

Required when delivery.mode is provider.

delivery

object

options

object

import

object

Adopt an existing registration instead of creating a new one. Created directly as approved with imported: true and allowance.counted: false; statuses backfilled from the provider where discoverable.

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

201The registration, already validating (or approved for imports).

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

401Missing or invalid API key.

402Registration allowance exhausted (allowance_exhausted).

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.

502Upstream provider (CPaaS/TCR/Google/carrier) failure; details in error.message.