Docs › API reference › Sanctions and AML

Screen an entity

Screens a company, organisation or vessel against sanctions data: the DFAT Consolidated List and OpenSanctions.

POSThttps://api.screenlyyid.com/api/v1/screening/entity

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key
`x-correlation-id`	string (uuid)	No	Correlation ID for this customer check

Request body#

Field	Type	Required	Description
`Name`	string	No
`Aliases`	array of string	No
`RegistrationNumber`	string	No
`Jurisdiction`	string	No
`IncorporationDate`	string	No
`Schema`	string	No	company \| organization \| vessel. Default: company.
`Sources`	array of string	No
`Options`	object	No
`Options.Threshold`	number (double)	No	Minimum score (0..1) for a result to count as matched. Default 0.8, allowed 0.5-0.99.
`Options.Limit`	integer (int32)	No	Max matches returned per source. Default 5, allowed 1-20.
`Options.Categories`	array of string	No	Restrict to "sanction" and/or "pep". Default: all.

Responses#

Status	Description
`200`	Successful response
`400`	Bad request
`401`	Unauthorized

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/screening/entity' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "Name": "<Name>",
  "Aliases": [
    "<Aliases>"
  ],
  "RegistrationNumber": "<RegistrationNumber>",
  "Jurisdiction": "<Jurisdiction>",
  "IncorporationDate": "<IncorporationDate>",
  "Schema": "<Schema>",
  "Sources": [
    "<Sources>"
  ],
  "Options": {
    "Threshold": 1,
    "Limit": 1,
    "Categories": [
      "<Categories>"
    ]
  }
}'

const body = {
  "Name": "<Name>",
  "Aliases": [
    "<Aliases>"
  ],
  "RegistrationNumber": "<RegistrationNumber>",
  "Jurisdiction": "<Jurisdiction>",
  "IncorporationDate": "<IncorporationDate>",
  "Schema": "<Schema>",
  "Sources": [
    "<Sources>"
  ],
  "Options": {
    "Threshold": 1,
    "Limit": 1,
    "Categories": [
      "<Categories>"
    ]
  }
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/screening/entity",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID",
      "Content-Type": "application/json"
    },
    "body": JSON.stringify(body)
  }
);

const result = await response.json();

import requests

payload = {
    "Name": "<Name>",
    "Aliases": [
        "<Aliases>"
    ],
    "RegistrationNumber": "<RegistrationNumber>",
    "Jurisdiction": "<Jurisdiction>",
    "IncorporationDate": "<IncorporationDate>",
    "Schema": "<Schema>",
    "Sources": [
        "<Sources>"
    ],
    "Options": {
        "Threshold": 1,
        "Limit": 1,
        "Categories": [
            "<Categories>"
        ]
    }
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/screening/entity',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID"
    },
    json=payload
)
result = response.json()

using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var json = @"{
  ""Name"": ""<Name>"",
  ""Aliases"": [
    ""<Aliases>""
  ],
  ""RegistrationNumber"": ""<RegistrationNumber>"",
  ""Jurisdiction"": ""<Jurisdiction>"",
  ""IncorporationDate"": ""<IncorporationDate>"",
  ""Schema"": ""<Schema>"",
  ""Sources"": [
    ""<Sources>""
  ],
  ""Options"": {
    ""Threshold"": 1,
    ""Limit"": 1,
    ""Categories"": [
      ""<Categories>""
    ]
  }
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/screening/entity", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();