Skip to main content

Entity Details

Retrieve detailed information about a specific sanctioned entity.

Endpoint: GET /v1/entities/{entity_id}


Request

Path Parameters

ParameterTypeDescription
entity_idstringThe unique SanctionsWise entity identifier

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Example Request

curl "https://api.sanctionswise.orchestraprime.ai/v1/entities/sw_ofac_sdn_35096" \
-H "x-api-key: YOUR_API_KEY"

Response

{
"entity_id": "sw_ofac_sdn_35096",
"primary_name": "VLADIMIR VLADIMIROVICH PUTIN",
"normalized_name": "VLADIMIR VLADIMIROVICH PUTIN",
"entity_type": "individual",
"aliases": [
{"alias_name": "PUTIN, Vladimir Vladimirovich", "alias_type": "a.k.a."},
{"alias_name": "Владимир Владимирович ПУТИН", "alias_type": "a.k.a."}
],
"identifiers": [
{"id_type": "date_of_birth", "id_value": "07 Oct 1952"}
],
"addresses": [
{"country": "Russia"}
],
"nationality_countries": ["Russia"],
"sanctions_programs": ["RUSSIA-EO14024", "UKRAINE-EO13660"],
"listing_date": "2022-02-25",
"source_authority": "US Treasury OFAC",
"source_list_id": "ofac_sdn",
"remarks": "President of the Russian Federation"
}

Response Fields

FieldTypeDescription
entity_idstringUnique SanctionsWise identifier
primary_namestringPrimary name as listed
normalized_namestringNormalized for matching
entity_typestringindividual, organization, vessel, aircraft
aliasesarrayKnown aliases and alternate names
identifiersarrayIdentification documents
addressesarrayKnown addresses
nationality_countriesarrayNationalities
sanctions_programsarrayOFAC programs (e.g., "RUSSIA-EO14024")
listing_datestringDate added to sanctions list
source_authoritystringIssuing authority
source_list_idstringSource list identifier
remarksstringAdditional notes from authority

Alias Object

FieldTypeDescription
alias_namestringThe alias or alternate name
alias_typestringType: a.k.a., f.k.a., n.k.a.

Identifier Object

FieldTypeDescription
id_typestringType of identifier
id_valuestringThe identifier value

Common identifier types:

  • passport
  • national_id
  • tax_id
  • date_of_birth
  • registration

Error Responses

404 Not Found

{
"error": "Entity not found",
"entity_id": "invalid_id"
}

Use Cases

1. Verify Match Details

After screening returns a match, retrieve full details:

def get_match_details(screening_result):
"""Get full details for all matches."""
details = []
for match in screening_result["matches"]:
entity = get_entity(match["entity_id"])
details.append({
"match": match,
"full_details": entity
})
return details

2. Compliance Documentation

Include full entity details in compliance reports:

def generate_compliance_report(screening_id, match):
entity = get_entity(match["entity_id"])
return {
"screening_id": screening_id,
"matched_entity": {
"id": entity["entity_id"],
"name": entity["primary_name"],
"type": entity["entity_type"],
"programs": entity["sanctions_programs"],
"listing_date": entity["listing_date"],
"source": entity["source_authority"]
},
"match_confidence": match["confidence_score"],
"match_type": match["match_type"]
}