Sugra Entity

Compose the KYB envelope for an entity

Changed on

Resolve an entity by (anchor, value) and compose the requested slices into the canonical KYB envelope. anchor is lei (via GLEIF), vat (via the EU VIES service), or siren / siret (via INSEE Sirene). Use ?include= (comma list of profile,screening,ownership) to select slices; the default is all three. The vat, siren and siret anchors have no ownership graph (no LEI) and a withheld identity is never screened clear. Fail-CLOSED: a screening failure returns 503, never a clear. ?as_of=YYYY-MM-DD scopes ONLY the screening slice to the dated snapshot for that date (point-in-time); the identity / ownership / VIES / Sirene slices are live external lookups with no historical snapshot and remain current. A malformed as_of returns 422; a date whose snapshot is absent returns 503 (fail-closed, never a live fallback).

get/api/v1/entity/{anchor}/{value}

Request

  • Base URL: https://sugra.ai
  • URL: https://sugra.ai/api/v1/entity/{anchor}/{value}
  • Auth: API key in header x-api-key

Path parameters

anchorstring required

Entity anchor type (lei, vat, siren, or siret).

valuestring required

Anchor value (LEI, VAT, SIREN, or SIRET).

Query parameters

includestring nullable

Comma list of slices to compose (profile, screening, ownership).

as_ofstring nullable

Point-in-time date (YYYY-MM-DD) scoping the screening slice to the dated snapshot. Identity/ownership remain current.

Response

Successful Response

Example response

{
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "data_age_days": 8.532,
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ],
    "stale_since": "2026-09-08T12:00:00Z",
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

  • d2472ec2cf81Revision changes
    • info

      added the non-success response with the status

  • 4f8853a61440Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status