Resolve a name to candidate corpus entities

POST

/api/v1/entity/resolve

Last modified:2026-09-03 17:14:13

Maintainer:Not configured

OperationId:post_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

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "name": "string",
    "country": "string",
    "type": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/entity/resolve' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "country": "string",
    "type": "string"
}'

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

{
    "data": {
        "candidates": [
            {
                "name": "string",
                "score": 0,
                "list": "string",
                "entity_id": "string",
                "restriction_type": "string",
                "program": null,
                "identifiers": {
                    "property1": "string",
                    "property2": "string"
                },
                "property1": "string",
                "property2": "string"
            }
        ],
        "property1": "string",
        "property2": "string"
    },
    "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": 0,
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true,
        "period": "string",
        "notes": "string"
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-09-03 17:14:13

Screen a batch of names against the sanctions corpus

Screening sources manifest: sanctions and PEP source lists, per-source staleness (max_age_hours), attribution, and covered regimes