Compose the KYB envelope for an entity

GET

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

Last modified:2026-07-19 17:02:27

Maintainer:Not configured

OperationId:entity_anchor_value

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).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/entity//?include=undefined&as_of=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

null

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-07-19 17:02:27

Screen a document identifier against the sanctions corpus

Compose the adverse-media slice of the KYB envelope