v5

latestOpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
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

{"stackTrail":"paths:/api/v1/entity/{anchor}/{value}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}