Sign in
Sugra Entity

Compose the KYB envelope for an entity

Resolve an entity by (anchor, value) and compose the requested slices into the canonical KYB envelope. anchor is lei (via GLEIF) or vat (via the EU VIES service). Use ?include= (comma list of profile,screening,ownership) to select slices; the default is all three. The vat anchor has no ownership graph (a VAT has no LEI) and a VAT whose identity is withheld 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 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}

Path parameters

anchorstring required

Entity anchor type (lei or vat).

Entity anchor type (lei or vat).

valuestring required

Anchor value (e.g. the LEI code or the VAT number).

Anchor value (e.g. the LEI code or the VAT number).

Query parameters

includestring nullable

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

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.

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",
    "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"
    ]
  }
}

Changes

Changed in 3 of the 21 revisions of this API.314

  • 560e8847c7b32See the full diff
    • ▲

      response property data/adverse_media/anyOf[subschema #1: AdverseMedia]/hits/anyOf[subschema #1]/items/matched_terms/anyOf[subschema #1]/items/ list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property data/screening/anyOf[subschema #1: Screening]/matches/anyOf[subschema #1]/items/rationale/anyOf[subschema #1]/items/ list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 914af3d38c7c12See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the required property data to the response with the 200 status

      response-required-property-added

    • ○

      added the required property meta to the response with the 200 status

      response-required-property-added

  • 4c4530760ba112See the full diff
    • ○

      added the optional property code to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property hint to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 503 status

      response-optional-property-added