---
title: "Search for entities in sanction lists"
method: GET
path: "/v2/search"
---

# Search for entities in sanction lists

`GET /v2/search`

Search for entities in the sanction lists based on the provided parameters

## Query parameters

- `name` string
- `source` string
- `sourceID` string
- `type` 'person' | 'business' | 'organization' | 'aircraft' | 'vessel'
- `altNames` string[]
- `limit` integer
- `minMatch` number, float
- `requestID` string
- `debug` boolean
- `debugSourceIDs` string
- `format` 'watchman' | 'senzing' | 'senzing/json' | 'senzing/jsonl' | 'senzing/ndjson'
- `gender` string
- `birthDate` string
- `deathDate` string
- `titles` string[]
- `created` string
- `dissolved` string
- `aircraftType` string
- `icaoCode` string
- `model` string
- `serialNumber` string
- `built` string
- `flag` string
- `imoNumber` string
- `vesselType` string
- `mmsi` string
- `callSign` string
- `owner` string
- `tonnage` integer
- `grossRegisteredTonnage` integer
- `email` string[]
- `emailAddress` string[]
- `emailAddresses` string[]
- `phone` string[]
- `phoneNumber` string[]
- `phoneNumbers` string[]
- `fax` string[]
- `faxNumber` string[]
- `faxNumbers` string[]
- `website` string[]
- `websites` string[]
- `address` string[]
- `addresses` string[]
- `cryptoAddress` string[]
- `cryptoAddresses` string[]
- `gov_passport` string
- `gov_drivers-license` string
- `gov_national-id` string
- `gov_tax-id` string
- `gov_ssn` string
- `gov_cedula` string
- `gov_curp` string
- `gov_cuit` string
- `gov_electoral` string
- `gov_business-registration` string
- `gov_commercial-registry` string
- `gov_birth-certificate` string
- `gov_refugee-id` string
- `gov_diplomatic-passport` string
- `gov_personal-id` string
- `gov_citizenship` string
- `gov_nationality` string

## Response `200`

Successful search

- SearchResponse
  - `query` Entity
    - `addresses` Address[] — Addresses associated with the entity
      - `line1` string — First line of the address
      - `line2` string — Second line of the address
      - `city` string — City name
      - `postalCode` string — Postal or ZIP code
      - `state` string — State, province, or region
      - `country` string — ISO-3166 country code
      - `latitude` number, double — Latitude of the address
      - `longitude` number, double — Longitude of the address
    - `affiliations` Affiliation[] — Other entities this entity is connected to
      - `entityName` string — Name of the related entity
      - `type` string — Relationship to the related entity (e.g., "Linked To", "Subsidiary Of", "Owned By")
      - `details` string — Additional details about the relationship
    - `aircraft` Aircraft
      - `altNames` string[] — Alternative names for the aircraft
      - `built` string, date-time — Build date of the aircraft
      - `flag` string — Country flag of the aircraft (ISO-3166)
      - `icaoCode` string — ICAO code of the aircraft
      - `model` string — Model of the aircraft
      - `name` string — Name of the aircraft
      - `serialNumber` string — Serial number of the aircraft
      - `type` string — Type of aircraft
    - `business` Business
      - `altNames` string[] — Alternative names for the business
      - `created` string, date-time — Creation date of the business
      - `dissolved` string, date-time — Dissolution date of the business
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the business
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the business
    - `contact` Contact
      - `emailAddresses` string[] — Email addresses associated with the entity
      - `faxNumbers` string[] — Fax numbers associated with the entity
      - `phoneNumbers` string[] — Phone numbers associated with the entity
      - `websites` string[] — Websites associated with the entity
    - `cryptoAddresses` CryptoAddress[] — Cryptocurrency addresses associated with the entity
      - `address` string — Cryptocurrency address
      - `currency` string — Cryptocurrency code (e.g., BTC, ETH, XBT)
    - `entityType` 'unknown' | 'person' | 'business' | 'organization' | 'aircraft' | 'vessel' — Type of entity
    - `historicalInfo` HistoricalInfo[] — Historical values for fields that have since changed
      - `type` string — Kind of historical value (e.g., "Former Name", "Previous Flag")
      - `value` string — The historical value itself
      - `date` string, date-time — When this value applied
    - `name` string — Primary name of the entity
    - `organization` Organization
      - `altNames` string[] — Alternative names for the organization
      - `created` string, date-time — Creation date of the organization
      - `dissolved` string, date-time — Dissolution date of the organization
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the organization
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the organization
    - `person` Person
      - `altNames` string[] — Alternative names for the person
      - `birthDate` string, date-time — Birth date of the person
      - `deathDate` string, date-time — Death date of the person
      - `gender` string — Gender of the person
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the person
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the person
      - `placeOfBirth` string — Place of birth of the person
      - `titles` string[] — Titles held by the person
    - `sanctionsInfo` SanctionsInfo
      - `programs` string[] — Sanction programs the entity falls under (e.g., "SDGT", "IRGC")
      - `secondary` boolean — Whether the entity is subject to secondary sanctions
      - `description` string — Additional sanctions details
    - `sourceList` string — Original list the entity is from
    - `sourceID` string — Original list identifier
    - `sourceData` object — Original source data
    - `vessel` Vessel
      - `altNames` string[] — Alternative names for the vessel
      - `built` string, date-time — Build date of the vessel
      - `callSign` string — Call sign of the vessel
      - `flag` string — Country flag of the vessel (ISO-3166)
      - `grossRegisteredTonnage` integer — Gross registered tonnage of the vessel
      - `imoNumber` string — IMO number of the vessel
      - `mmsi` string — MMSI of the vessel
      - `model` string — Model of the vessel
      - `name` string — Name of the vessel
      - `owner` string — Owner of the vessel
      - `tonnage` integer — Tonnage of the vessel
      - `type` string — Type of vessel
  - `entities` SearchedEntity[] — List of matching entities
    - `addresses` Address[] — Addresses associated with the entity
      - `line1` string — First line of the address
      - `line2` string — Second line of the address
      - `city` string — City name
      - `postalCode` string — Postal or ZIP code
      - `state` string — State, province, or region
      - `country` string — ISO-3166 country code
      - `latitude` number, double — Latitude of the address
      - `longitude` number, double — Longitude of the address
    - `affiliations` Affiliation[] — Other entities this entity is connected to
      - `entityName` string — Name of the related entity
      - `type` string — Relationship to the related entity (e.g., "Linked To", "Subsidiary Of", "Owned By")
      - `details` string — Additional details about the relationship
    - `aircraft` Aircraft
      - `altNames` string[] — Alternative names for the aircraft
      - `built` string, date-time — Build date of the aircraft
      - `flag` string — Country flag of the aircraft (ISO-3166)
      - `icaoCode` string — ICAO code of the aircraft
      - `model` string — Model of the aircraft
      - `name` string — Name of the aircraft
      - `serialNumber` string — Serial number of the aircraft
      - `type` string — Type of aircraft
    - `business` Business
      - `altNames` string[] — Alternative names for the business
      - `created` string, date-time — Creation date of the business
      - `dissolved` string, date-time — Dissolution date of the business
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the business
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the business
    - `contact` Contact
      - `emailAddresses` string[] — Email addresses associated with the entity
      - `faxNumbers` string[] — Fax numbers associated with the entity
      - `phoneNumbers` string[] — Phone numbers associated with the entity
      - `websites` string[] — Websites associated with the entity
    - `cryptoAddresses` CryptoAddress[] — Cryptocurrency addresses associated with the entity
      - `address` string — Cryptocurrency address
      - `currency` string — Cryptocurrency code (e.g., BTC, ETH, XBT)
    - `entityType` 'unknown' | 'person' | 'business' | 'organization' | 'aircraft' | 'vessel' — Type of entity
    - `historicalInfo` HistoricalInfo[] — Historical values for fields that have since changed
      - `type` string — Kind of historical value (e.g., "Former Name", "Previous Flag")
      - `value` string — The historical value itself
      - `date` string, date-time — When this value applied
    - `name` string — Primary name of the entity
    - `organization` Organization
      - `altNames` string[] — Alternative names for the organization
      - `created` string, date-time — Creation date of the organization
      - `dissolved` string, date-time — Dissolution date of the organization
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the organization
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the organization
    - `person` Person
      - `altNames` string[] — Alternative names for the person
      - `birthDate` string, date-time — Birth date of the person
      - `deathDate` string, date-time — Death date of the person
      - `gender` string — Gender of the person
      - `governmentIDs` GovernmentID[] — Government-issued identifiers for the person
        - `name` string — Display name for this identifier
        - `type` 'passport' | 'drivers-license' | 'national-id' | 'tax-id' | 'ssn' | 'cedula' | 'curp' | 'cuit' | 'electoral' | 'business-registration' | 'commercial-registry' | 'birth-certificate' | 'refugee-id' | 'diplomatic-passport' | 'personal-id' | 'citizenship' | 'nationality' — Kind of government ID
        - `country` string — Issuing country (ISO-3166)
        - `identifier` string — The identifier value
      - `name` string — Name of the person
      - `placeOfBirth` string — Place of birth of the person
      - `titles` string[] — Titles held by the person
    - `sanctionsInfo` SanctionsInfo
      - `programs` string[] — Sanction programs the entity falls under (e.g., "SDGT", "IRGC")
      - `secondary` boolean — Whether the entity is subject to secondary sanctions
      - `description` string — Additional sanctions details
    - `sourceList` string — Original list the entity is from
    - `sourceID` string — Original list identifier
    - `sourceData` object — Original source data
    - `vessel` Vessel
      - `altNames` string[] — Alternative names for the vessel
      - `built` string, date-time — Build date of the vessel
      - `callSign` string — Call sign of the vessel
      - `flag` string — Country flag of the vessel (ISO-3166)
      - `grossRegisteredTonnage` integer — Gross registered tonnage of the vessel
      - `imoNumber` string — IMO number of the vessel
      - `mmsi` string — MMSI of the vessel
      - `model` string — Model of the vessel
      - `name` string — Name of the vessel
      - `owner` string — Owner of the vessel
      - `tonnage` integer — Tonnage of the vessel
      - `type` string — Type of vessel
    - `match` number, float — Match score for this entity against the query
    - `debug` string — Base64-encoded field-level match details (only set when ?debug=true)
    - `details` SimilarityScore
      - `pieces` ScorePiece[] — Per-comparison score breakdown
        - `score` number, float — Score for this piece (0-1)
        - `weight` number, float — Weight applied to this piece in the final score
        - `matched` boolean — Whether this piece matched
        - `required` boolean — Whether this piece is required for a high overall score
        - `exact` boolean — Whether this piece was an exact match
        - `fieldsCompared` integer — Number of fields that were compared
        - `pieceType` string — Type of comparison this piece represents (e.g., "identifiers", "name")
      - `finalScore` number, float — Computed final match score

## Other responses

- `400` — Bad request
- `default` — Unexpected error

---

[API](https://skmtc.net/moov-io/apis/watchman-api.md) · [All operations](https://skmtc.net/moov-io/apis/watchman-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moov-io/watchman-api/versions/42ffeeb1e25a/schema)