Skip to content
Peritus
API reference · Query

Enrich entity

POST/v1/entities:enrich

The bundle of an entity's kind: each part's facts, fetched together from one snapshot, and each part ok or missing.

scope
read
auth
Bearer key
operationId
EnrichEntity
MCP tool
enrich_entity

Request body

application/json · EnrichRequest · no other fields

Request body fields
FieldTypeRequiredLimitsHolds
referenceReferenceyesAn entity by ID or by an exact identifier; exactly one.
max_age_secondsintegerno1 to 315360000
modestrict · standard · broadnoWhich items could be served. Each mode returns everything the one before it does.

Response

200 · EnrichResponse. The bundle, partial when a part is missing, or typed abstentions.

Response fields
FieldTypeHolds
response_idResponseIDA response's ID. It replays and compares that exact response.
statusanswered · partial · abstainedWhether there is an answer.
as_ofAsOfWhen the answer applies (valid_at), and what the record held then (known_at).
modestrict · standard · broadWhich items could be served. Each mode returns everything the one before it does.
presetstring · nullableThe key's preset, if any.
itemsItem[]The cited facts.
abstentionsAbstention[]Why part of the question has no answer.
negative_resultsNegativeResult[]What was searched, and found nothing.
withheldWithheld[]Items left out, by reason and count.
attributionsAttribution[]Text to repeat where you show the data.
metaMetaThe policy version, the index versions, and the milliseconds the server took.
entityany · nullable
partsobject[]
unresolvedUnresolved[]

Rate-limit headers

RateLimit-Limit
The bucket's size.
RateLimit-Remaining
Tokens left in it.
RateLimit-Reset
Seconds until it is full.

Problems

RFC 9457 application/problem+json. An abstention is not one of these: it is a 200.

Problems
HTTPCodeWhen
400INVALID_REQUESTMalformed JSON, unknown fields, bad filter, limit exceeded
401UNAUTHENTICATEDMissing, malformed, or revoked key
403FORBIDDEN_SCOPEThe key lacks the required scope
413PAYLOAD_TOO_LARGEBody or upload over the limit
429RATE_LIMITEDRate limit or per-tenant model cap
500INTERNAL, POLICY_ASSERT_FAILED, RESPONSE_UNREPLAYABLEServer fault. The last two also alert
503STORE_UNAVAILABLE, LLM_UNAVAILABLE, LOG_UNAVAILABLEA dependency is down or a budget tripped
504TIMEOUTA deadline was exceeded

Sample

Request
POST /v1/entities:enrich
Content-Type: application/json

{
  "reference": {
    "identifier": {
      "scheme": "ofac_uid",
      "value": "3751"
    }
  },
  "mode": "standard"
}
Sample response · GET /v1/samples/enrich
{
  "abstentions": [
    {
      "checked": [
        {
          "check": "freshness",
          "note": "list ofac_sls is stale",
          "passed": false
        }
      ],
      "code": "STALE",
      "detail": {
        "code": "SOURCE_UNREADABLE"
      },
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "field": "sanctions.identifier",
      "resolution_hint": "Ask again after the source's next successful fetch, or use standard mode to see the value labeled with its freshness."
    }
  ],
  "as_of": {
    "known_at": "2026-10-28T14:34:53.202922Z",
    "valid_at": "2026-10-28T14:34:53.202922Z"
  },
  "attributions": [
    {
      "source_id": "ofac_sls",
      "text": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service"
    }
  ],
  "entity": {
    "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
    "kind": "org",
    "name": "MOA NICKEL SA",
    "redirected_from": null
  },
  "items": [
    {
      "authority": "official_database",
      "claim_type": "fact",
      "claimant": null,
      "conditions": null,
      "corroboration": [],
      "derived": null,
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "evidence": {
        "passage_id": "pas_06GR5VVHPSZDV77D9BFJBCNB8G",
        "span": [
          0,
          1191
        ],
        "text": "<SanctionsEntry ID=\"3751\" ProfileID=\"3751\" ListID=\"1550\">\r\n      <EntryEvent ID=\"3751\" EntryEventTypeID=\"1\" LegalBasisID=\"91707\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <EntryEvent ID=\"1003751\" EntryEventTypeID=\"1\" LegalBasisID=\"92884\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <SanctionsMeasure ID=\"4293\" SanctionsTypeID=\"1705\">\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"126312\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"187865\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA-EO14404</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n    </SanctionsEntry>"
      },
      "fact_version_id": "fv_06GR5VVHQHSDX77J2HD9CC6QH4",
      "field": "sanctions.listing_status",
      "license": {
        "attribution": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service",
        "serve_policy": "full",
        "terms_url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/APIDocumentation.docx"
      },
      "origin": "shared",
      "places": null,
      "source": {
        "blob_sha256": "5c6a712b0f3865c123f9e1a4d840943f5c2f0da2b6283c8ae07d6a8933b0ea3f",
        "credibility": {
          "propaganda_risk": "low",
          "state_affiliated": false
        },
        "family": "us_treasury_ofac",
        "fetched_at": "2026-10-28T14:33:52.635305Z",
        "freshness": "stale",
        "id": "ofac_sls",
        "name": "OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)",
        "parser_version": "2",
        "url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/SDN_ADVANCED.XML"
      },
      "tier": "verified",
      "times": {
        "last_verified_at": "2026-10-28T14:33:52.635305Z",
        "publisher_released_at": "2026-10-21T00:00:00Z",
        "recorded_at": "2026-10-28T14:33:52.635305Z",
        "valid": {
          "from": "1995-05-23T00:00:00Z",
          "precision": "day",
          "to": null
        }
      },
      "value": {
        "list": "SDN List",
        "status": "listed",
        "measures": [
          "Block"
        ],
        "legal_bases": [
          "Cuban Assets Control Regulations (CACR)",
          "Executive Order 14404 (Cuba)"
        ]
      }
    },
    {
      "authority": "official_database",
      "claim_type": "fact",
      "claimant": null,
      "conditions": null,
      "corroboration": [],
      "derived": null,
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "evidence": {
        "passage_id": "pas_06GR5VVHPSZDV77D9BFJBCNB8G",
        "span": [
          0,
          1191
        ],
        "text": "<SanctionsEntry ID=\"3751\" ProfileID=\"3751\" ListID=\"1550\">\r\n      <EntryEvent ID=\"3751\" EntryEventTypeID=\"1\" LegalBasisID=\"91707\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <EntryEvent ID=\"1003751\" EntryEventTypeID=\"1\" LegalBasisID=\"92884\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <SanctionsMeasure ID=\"4293\" SanctionsTypeID=\"1705\">\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"126312\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"187865\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA-EO14404</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n    </SanctionsEntry>"
      },
      "fact_version_id": "fv_06GR5VVHQHTW9CFS9DCX9R3YX4",
      "field": "sanctions.program",
      "license": {
        "attribution": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service",
        "serve_policy": "full",
        "terms_url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/APIDocumentation.docx"
      },
      "origin": "shared",
      "places": null,
      "source": {
        "blob_sha256": "5c6a712b0f3865c123f9e1a4d840943f5c2f0da2b6283c8ae07d6a8933b0ea3f",
        "credibility": {
          "propaganda_risk": "low",
          "state_affiliated": false
        },
        "family": "us_treasury_ofac",
        "fetched_at": "2026-10-28T14:33:52.635305Z",
        "freshness": "stale",
        "id": "ofac_sls",
        "name": "OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)",
        "parser_version": "2",
        "url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/SDN_ADVANCED.XML"
      },
      "tier": "verified",
      "times": {
        "last_verified_at": "2026-10-28T14:33:52.635305Z",
        "publisher_released_at": "2026-10-21T00:00:00Z",
        "recorded_at": "2026-10-28T14:33:52.635305Z",
        "valid": {
          "from": "2026-10-21T00:00:00Z",
          "precision": "day",
          "to": null
        }
      },
      "value": {
        "list": "SDN List",
        "program": "CUBA"
      }
    },
    {
      "authority": "official_database",
      "claim_type": "fact",
      "claimant": null,
      "conditions": null,
      "corroboration": [],
      "derived": null,
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "evidence": {
        "passage_id": "pas_06GR5VVHPSZDV77D9BFJBCNB8G",
        "span": [
          0,
          1191
        ],
        "text": "<SanctionsEntry ID=\"3751\" ProfileID=\"3751\" ListID=\"1550\">\r\n      <EntryEvent ID=\"3751\" EntryEventTypeID=\"1\" LegalBasisID=\"91707\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <EntryEvent ID=\"1003751\" EntryEventTypeID=\"1\" LegalBasisID=\"92884\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <SanctionsMeasure ID=\"4293\" SanctionsTypeID=\"1705\">\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"126312\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"187865\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA-EO14404</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n    </SanctionsEntry>"
      },
      "fact_version_id": "fv_06GR5VVHQHWAQATR0FWRTCDXKM",
      "field": "sanctions.program",
      "license": {
        "attribution": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service",
        "serve_policy": "full",
        "terms_url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/APIDocumentation.docx"
      },
      "origin": "shared",
      "places": null,
      "source": {
        "blob_sha256": "5c6a712b0f3865c123f9e1a4d840943f5c2f0da2b6283c8ae07d6a8933b0ea3f",
        "credibility": {
          "propaganda_risk": "low",
          "state_affiliated": false
        },
        "family": "us_treasury_ofac",
        "fetched_at": "2026-10-28T14:33:52.635305Z",
        "freshness": "stale",
        "id": "ofac_sls",
        "name": "OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)",
        "parser_version": "2",
        "url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/SDN_ADVANCED.XML"
      },
      "tier": "verified",
      "times": {
        "last_verified_at": "2026-10-28T14:33:52.635305Z",
        "publisher_released_at": "2026-10-21T00:00:00Z",
        "recorded_at": "2026-10-28T14:33:52.635305Z",
        "valid": {
          "from": "2026-10-21T00:00:00Z",
          "precision": "day",
          "to": null
        }
      },
      "value": {
        "list": "SDN List",
        "program": "CUBA-EO14404"
      }
    },
    {
      "authority": "official_database",
      "claim_type": "fact",
      "claimant": null,
      "conditions": null,
      "corroboration": [],
      "derived": null,
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "evidence": {
        "passage_id": "pas_06GR5VVHPSZDV77D9BFJBCNB8G",
        "span": [
          0,
          1191
        ],
        "text": "<SanctionsEntry ID=\"3751\" ProfileID=\"3751\" ListID=\"1550\">\r\n      <EntryEvent ID=\"3751\" EntryEventTypeID=\"1\" LegalBasisID=\"91707\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <EntryEvent ID=\"1003751\" EntryEventTypeID=\"1\" LegalBasisID=\"92884\">\r\n        <Comment />\r\n        <Date CalendarTypeID=\"1\">\r\n          <Year>1995</Year>\r\n          <Month>5</Month>\r\n          <Day>23</Day>\r\n        </Date>\r\n      </EntryEvent>\r\n      <SanctionsMeasure ID=\"4293\" SanctionsTypeID=\"1705\">\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"126312\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n      <SanctionsMeasure ID=\"187865\" SanctionsTypeID=\"1\">\r\n        <Comment>CUBA-EO14404</Comment>\r\n        <DatePeriod CalendarTypeID=\"1\" YearFixed=\"true\" MonthFixed=\"true\" DayFixed=\"true\" />\r\n      </SanctionsMeasure>\r\n    </SanctionsEntry>"
      },
      "fact_version_id": "fv_06GR5VVHQDZP96R0EWF7Y4JN2M",
      "field": "sanctions.listing_date",
      "license": {
        "attribution": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service",
        "serve_policy": "full",
        "terms_url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/APIDocumentation.docx"
      },
      "origin": "shared",
      "places": null,
      "source": {
        "blob_sha256": "5c6a712b0f3865c123f9e1a4d840943f5c2f0da2b6283c8ae07d6a8933b0ea3f",
        "credibility": {
          "propaganda_risk": "low",
          "state_affiliated": false
        },
        "family": "us_treasury_ofac",
        "fetched_at": "2026-10-28T14:33:52.635305Z",
        "freshness": "stale",
        "id": "ofac_sls",
        "name": "OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)",
        "parser_version": "2",
        "url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/SDN_ADVANCED.XML"
      },
      "tier": "verified",
      "times": {
        "last_verified_at": "2026-10-28T14:33:52.635305Z",
        "publisher_released_at": "2026-10-21T00:00:00Z",
        "recorded_at": "2026-10-28T14:33:52.635305Z",
        "valid": {
          "from": "1995-05-23T00:00:00Z",
          "precision": "day",
          "to": null
        }
      },
      "value": {
        "date": "1995-05-23",
        "list": "SDN List",
        "events": [
          "1995-05-23"
        ]
      }
    },
    {
      "authority": "official_database",
      "claim_type": "fact",
      "claimant": null,
      "conditions": null,
      "corroboration": [],
      "derived": null,
      "entity": {
        "id": "ent_06GR5VVHPDW2Q1HYD75X1W4YNM",
        "kind": "org",
        "name": "MOA NICKEL SA",
        "redirected_from": null
      },
      "evidence": {
        "passage_id": "pas_06GR5VVHPSZC7783JV0E5GYN2W",
        "span": [
          0,
          301
        ],
        "text": "<DocumentedName ID=\"4443\" FixedRef=\"3751\" DocNameStatusID=\"1\">\r\n              <DocumentedNamePart>\r\n                <NamePartValue NamePartGroupID=\"6803\" ScriptID=\"215\" ScriptStatusID=\"1\" Acronym=\"false\">MOA NICKEL SA</NamePartValue>\r\n              </DocumentedNamePart>\r\n            </DocumentedName>"
      },
      "fact_version_id": "fv_06GR5VVHQ5Z7HFDZT544B568SM",
      "field": "sanctions.alias",
      "license": {
        "attribution": "U.S. Department of the Treasury, Office of Foreign Assets Control (OFAC), Sanctions List Service",
        "serve_policy": "full",
        "terms_url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/APIDocumentation.docx"
      },
      "origin": "shared",
      "places": null,
      "source": {
        "blob_sha256": "5c6a712b0f3865c123f9e1a4d840943f5c2f0da2b6283c8ae07d6a8933b0ea3f",
        "credibility": {
          "propaganda_risk": "low",
          "state_affiliated": false
        },
        "family": "us_treasury_ofac",
        "fetched_at": "2026-10-28T14:33:52.635305Z",
        "freshness": "stale",
        "id": "ofac_sls",
        "name": "OFAC Sanctions List Service (SDN and Consolidated non-SDN lists)",
        "parser_version": "2",
        "url": "https://sanctionslistservice.ofac.treas.gov/api/PublicationPreview/exports/SDN_ADVANCED.XML"
      },
      "tier": "verified",
      "times": {
        "last_verified_at": "2026-10-28T14:33:52.635305Z",
        "publisher_released_at": "2026-10-21T00:00:00Z",
        "recorded_at": "2026-10-28T14:33:52.635305Z",
        "valid": {
          "from": null,
          "precision": "day",
          "to": null
        }
      },
      "value": {
        "name": "MOA NICKEL SA",
        "type": "Name",
        "script": "Latin",
        "strength": "primary"
      }
    }
  ],
  "meta": {
    "index_versions": {
      "ofac_sls": "01a182ef-71a0-7861-9595-c4ecfc82ba02"
    },
    "policy_version": 1,
    "server_ms": 12
  },
  "mode": "standard",
  "negative_results": [],
  "parts": [
    {
      "bundle_part": "sanctions_exposure",
      "status": "ok"
    },
    {
      "bundle_part": "identity",
      "status": "ok"
    }
  ],
  "preset": null,
  "response_id": "resp_06GR5VVKKXTVFDXP6XNN43EFDM",
  "status": "partial",
  "unresolved": [],
  "withheld": []
}