Screen By Name

Beta

GET

/v1/screen

GET

/v1/screen

curl -G https://api.sayari.com/v1/screen \
     -H "Authorization: Bearer <token>" \
     --data-urlencode "name=AEROCARIBBEAN AIRLINES" \
     -d type=company

{
  "request": {
    "project_id": "YVB88Y",
    "project_entity_id": "YVodz6"
  },
  "project_entity_attributes": {
    "name": {
      "match_resolution": true,
      "values": [
        {
          "value": "AEROCARIBBEAN AIRLINES"
        }
      ]
    }
  },
  "data": [
    {
      "reference_id": "ofac-sdn-48846",
      "org_id": "ofac",
      "release_name": "2024-01-01",
      "name_matches": [
        {
          "name": "AEROCARIBBEAN AIRLINES",
          "similarity_score": 0.4,
          "confidence_score": 0.5,
          "explanation": "High name similarity with matching organization type"
        }
      ],
      "type": "company",
      "entity_match": {
        "entity_reference_id": "ofac-sdn-48846",
        "type": "company",
        "additional_information": [
          {
            "value": "Designated pursuant to Executive Order 13224",
            "type": "Designation Basis",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "address": [
          {
            "value": "Calle 23 No. 64, Havana, Cuba",
            "city": "Havana",
            "state": null,
            "country": "CU",
            "postcode": "10400",
            "road": null,
            "house": "Calle 23 No. 64",
            "house_number": null,
            "type": null,
            "unit": null,
            "x": null,
            "y": null,
            "near": null,
            "level": null,
            "building": null,
            "suburb": null,
            "island": null,
            "po_box": null,
            "entrance": null,
            "staircase": null,
            "category": null,
            "world_region": null,
            "city_district": null,
            "metro_station": null,
            "country_region": null,
            "state_district": null,
            "precision_code": null,
            "date": null,
            "to_date": null,
            "from_date": null,
            "language": null,
            "translated": null,
            "transliterated": null,
            "extra": [
              {
                "key": "Country Field Added By",
                "value": "libpostal"
              }
            ]
          }
        ],
        "business_purpose": [
          {
            "value": "Air transportation",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "company_type": [
          {
            "value": "State-owned enterprise",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "contact": [
          {
            "value": "+53 7 835-0216",
            "type": "phone",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          },
          {
            "value": "info@aerocaribbean.cu",
            "type": "email",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "country": [
          {
            "value": "CU",
            "context": "domicile",
            "state": null,
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "finances": [
          {
            "value": "1500000",
            "currency": "USD",
            "type": "share_capital",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "financials": [
          {
            "value": "12000000",
            "currency": "USD",
            "type": "annual_revenue",
            "year": "2019",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "gender": null,
        "generic": [
          {
            "value": "CUBA",
            "type": "program",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "identifier": [
          {
            "value": "48846",
            "type": "SDN ID",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          },
          {
            "value": "CU-1234567",
            "type": "registration_number",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "measurement": [
          {
            "value": "750",
            "unit": "employees",
            "type": "headcount",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "monetary_value": [
          {
            "value": "2500000",
            "currency": "USD",
            "type": "FOB",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "name": [
          {
            "value": "AEROCARIBBEAN AIRLINES",
            "context": "primary",
            "date": null,
            "extra": null,
            "to_date": null,
            "language": null,
            "from_date": null,
            "translated": null,
            "transliterated": null
          }
        ],
        "person_status": null,
        "position": [
          {
            "value": "Minister of Transportation",
            "type": "oversight",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "risk_intelligence": [
          {
            "list": "OFAC Specially Designated Nationals (SDN) List",
            "type": "sanctioned",
            "score": null,
            "reason": null,
            "program": "CUBA",
            "authority": "OFAC",
            "from_date": "2002-01-01",
            "to_date": null,
            "date": null,
            "extra": [
              {
                "key": "License Policy",
                "value": "Presumption of denial."
              }
            ]
          }
        ],
        "risk_factors": [
          "sanctioned"
        ],
        "shares": [
          {
            "value": "100",
            "unit": "%",
            "type": "government_owned",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "status": [
          {
            "value": "active",
            "date": "2020-01-01",
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "translated_name": [
          {
            "value": "Aerolíneas AeroCaribbean",
            "context": null,
            "date": null,
            "extra": null,
            "to_date": null,
            "language": "es",
            "from_date": null,
            "translated": null,
            "transliterated": null
          }
        ],
        "weak_identifier": [
          {
            "value": "AEROCARIBBEAN",
            "type": "common_name",
            "date": null,
            "to_date": null,
            "from_date": null,
            "extra": null
          }
        ],
        "risk_event": [
          {
            "category": "Law Enforcement",
            "subcategory": "Sanctions",
            "event_type": "SDN Designation",
            "title": "OFAC SDN Designation — CUBA Sanctions Program",
            "source_url": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=48846",
            "credibility": "Official",
            "event_stage": "Active",
            "penalty_and_restriction": "Asset freeze; prohibit US persons from transacting",
            "dismissal_and_clearance": null
          }
        ]
      }
    }
  ]
}

Screen a name against watchlist records to identify potential matches. Requires the screened_risk role.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

namestringRequired

Name to screen against watchlist records.

typestringOptional

Comma-separated list of watchlist record types to filter by.

release_namestringOptional

Watchlist release name to filter by.

Response

This endpoint returns an object.

requestobject

project_entity_attributesmap from strings to objects

datalist of objects

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

422

Unprocessable Content

429

Rate Limit Exceeded

500

Internal Server Error