REST API · Version 1

API reference

Retrieve regulatory alert records or search the current Embargo registry from an authenticated organization workflow.

Access contract

Plan: Business ($299/month)
Base URL: https://getembargo.com/api/v1
Transport: HTTPS · JSON · no-store

01 · Access

Authentication

Send an organization API key as a Bearer token. An active Clerk organization session is also accepted for requests made from the signed-in product. Non-admin organizations must have the Business plan.

curl https://getembargo.com/api/v1/alerts \
  -H "Authorization: Bearer emb_live_your_key_here"

Keys begin with emb_live_ and are scoped to one organization.
Keep keys in an environment variable or secrets manager; do not commit or log them.
Revoke a compromised key from Settings. No specific revocation latency is promised here.

02 · Regulatory records

GET/api/v1/alerts

Returns a newest-first, paginated set of recorded alerts. Titles and summaries are secondary records; use each source_url to review the issuing material.

Rate limit: 120 requests per minute, per organization.

Parameter	Type	Contract
limit	integer	Records to return. Default 25; minimum 1; maximum 100.
offset	integer	Safe, non-negative pagination offset. Default 0.
jurisdiction	string	Exact jurisdiction value to filter, up to 100 characters.
action_type	string	One of Urgent, Monitor, or FYI.
since	ISO 8601	Only records published on or after the supplied date or timestamp.

Request

curl "https://getembargo.com/api/v1/alerts?jurisdiction=US+BIS&limit=5" \
  -H "Authorization: Bearer emb_live_your_key_here"

Response shape

Values below are placeholders that show the contract; they are not a statement about any real party or notice.

{
  "alerts": [{
    "id": "alert_record_id",
    "jurisdiction": "source jurisdiction",
    "title": "recorded source title",
    "summary": "recorded source synopsis or null",
    "source_url": "https://issuing-authority.example/record",
    "published_at": "ISO-8601 timestamp",
    "action_type": "Urgent | Monitor | FYI | null",
    "affected_audience": "recorded audience or null"
  }],
  "total": 0,
  "has_more": false,
  "meta": { "limit": 5, "offset": 0, "generated_at": "ISO-8601 timestamp" }
}

03 · Registry records

GET/api/v1/entities

Searches canonical names and known aliases in one verified registry publication. The result is registry discovery—not identity confirmation, transaction clearance, or legal advice.

Rate limit: 60 searches per minute, per organization.

Parameter	Type	Contract
qRequired	string	Name query. Minimum 2 characters; maximum 200.
jurisdiction	string	Exact active registry-membership jurisdiction to filter.
limit	integer	Records to return. Default 10; minimum 1; maximum 50.

Request

curl "https://getembargo.com/api/v1/entities?q=example+company&limit=3" \
  -H "Authorization: Bearer emb_live_your_key_here"

Response shape

Placeholder values demonstrate fields without asserting an identity match for a real party.

{
  "entities": [{
    "id": "entity_record_id",
    "canonical_name": "recorded canonical name",
    "slug": "public-profile-slug",
    "country": "recorded country or null",
    "entity_type": "recorded type or null",
    "aliases": [],
    "profile_url": "https://getembargo.com/entities/public-profile-slug"
  }],
  "total": 0,
  "meta": {
    "q": "example company",
    "limit": 3,
    "registry_publication": {},
    "result_type": "registry_discovery",
    "qualification": "This endpoint searches registry records and is not a compliance screening or legal clearance."
  }
}

04 · Failure contract

Errors and limits

Errors use the JSON shape { "error": "message" }. Dependency or evidence failures return 503 instead of a partial success.

Status	Meaning
400	The request parameters are invalid.
401	The API key or authenticated organization session is missing or invalid.
403	The organization does not have Business-plan API access.
422	The verified jurisdiction candidate window is too broad; refine the entity query.
429	The endpoint's per-organization rate limit has been reached.
503	Authentication, subscription, alert, or registry evidence could not be verified. No partial result was issued.

Test the contract against your workflow.

Business customers can generate keys in Settings. Bring integration and evidence requirements to a guided demo.

Open Settings Guided demo