---
title: "Resolve a name to candidate corpus entities"
method: POST
path: "/api/v1/entity/resolve"
tags: ["Sugra Entity"]
---

# Resolve a name to candidate corpus entities

`POST /api/v1/entity/resolve`

Return the top candidate entities from the sanctions corpus matching a name, each with a confidence score and any identifiers on the record. This is identity RESOLUTION, not a screening verdict - there is no `clear`/`review`/`hit` status. Fail-CLOSED: if no sanctions list is loaded the request returns 503.

## Request body

- ResolveRequest — Identity-resolution request: find candidate corpus entities matching a name. ``name`` reuses the single-screen length bound. ``type`` is an optional entity-type hint (currently advisory only).
  - `name` string, required
  - `country` string, nullable
  - `type` string, nullable

## Response `200`

Successful Response

- EnvelopeEntityResolveData
  - `data` EntityResolveData, required
    - `candidates` Candidate[], nullable
      - `name` string, nullable
      - `score` union
        - integer
        - number
      - `list` string, nullable
      - `entity_id` string, nullable
      - `restriction_type` string, nullable
      - `program` unknown
      - `identifiers` object, nullable
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/revisions/914af3d38c7c/schema)