Docs › API reference › Sanctions and AML

Screen a person

Screens a person against sanctions and PEP data: the DFAT Consolidated List and OpenSanctions. Use the Sources field to choose dfat, opensanctions, or both (the default).

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

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
`GivenName`	string	No
`MiddleName`	string	No
`FamilyName`	string	No
`DateOfBirth`	string	No	YYYY, YYYY-MM or YYYY-MM-DD.
`Nationality`	string	No	ISO 3166 alpha-2.
`Country`	string	No
`Address`	object	No
`Address.Line1`	string	No
`Address.Locality`	string	No
`Address.State`	string	No
`Address.PostalCode`	string	No
`Address.Country`	string	No
`Sources`	array of string	No	"dfat", "opensanctions". Default: both.
`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/person' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "GivenName": "Jane",
  "MiddleName": "<MiddleName>",
  "FamilyName": "Citizen",
  "DateOfBirth": "<DateOfBirth>",
  "Nationality": "<Nationality>",
  "Country": "AU",
  "Address": {
    "Line1": "<Line1>",
    "Locality": "<Locality>",
    "State": "<State>",
    "PostalCode": "<PostalCode>",
    "Country": "AU"
  },
  "Sources": [
    "<Sources>"
  ],
  "Options": {
    "Threshold": 1,
    "Limit": 1,
    "Categories": [
      "<Categories>"
    ]
  }
}'

const body = {
  "GivenName": "Jane",
  "MiddleName": "<MiddleName>",
  "FamilyName": "Citizen",
  "DateOfBirth": "<DateOfBirth>",
  "Nationality": "<Nationality>",
  "Country": "AU",
  "Address": {
    "Line1": "<Line1>",
    "Locality": "<Locality>",
    "State": "<State>",
    "PostalCode": "<PostalCode>",
    "Country": "AU"
  },
  "Sources": [
    "<Sources>"
  ],
  "Options": {
    "Threshold": 1,
    "Limit": 1,
    "Categories": [
      "<Categories>"
    ]
  }
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/screening/person",
  {
    "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 = {
    "GivenName": "Jane",
    "MiddleName": "<MiddleName>",
    "FamilyName": "Citizen",
    "DateOfBirth": "<DateOfBirth>",
    "Nationality": "<Nationality>",
    "Country": "AU",
    "Address": {
        "Line1": "<Line1>",
        "Locality": "<Locality>",
        "State": "<State>",
        "PostalCode": "<PostalCode>",
        "Country": "AU"
    },
    "Sources": [
        "<Sources>"
    ],
    "Options": {
        "Threshold": 1,
        "Limit": 1,
        "Categories": [
            "<Categories>"
        ]
    }
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/screening/person',
    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 = @"{
  ""GivenName"": ""Jane"",
  ""MiddleName"": ""<MiddleName>"",
  ""FamilyName"": ""Citizen"",
  ""DateOfBirth"": ""<DateOfBirth>"",
  ""Nationality"": ""<Nationality>"",
  ""Country"": ""AU"",
  ""Address"": {
    ""Line1"": ""<Line1>"",
    ""Locality"": ""<Locality>"",
    ""State"": ""<State>"",
    ""PostalCode"": ""<PostalCode>"",
    ""Country"": ""AU""
  },
  ""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/person", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();